资讯专栏INFORMATION COLUMN

MyBatis Generator 自定义生成注释

sugarmo / 324人阅读

摘要:最近做项目,使用的是,为了偷懒,我自然而然的想到了使用来生成数据库表对应的实体代码和代码。

最近做项目,ORM 使用的是 MyBatis,为了偷懒,我自然而然的想到了使用 MyBatis Generator(MBG)来生成数据库表对应的实体代码和 Mapper 代码。于是做了如下的配置(对 MBG 配置不熟悉的同学可以参考 Mybatis Generator最完整配置详解):



        

    
    

    
        
        
        
        
        
        

        
        
        

        
        
            
        

        
        
            
        

        
        
            
        

        
        
        

数据库建库建表的代码:

CREATE SCHEMA `db_test` DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ;

CREATE TABLE `db_test`.`t_user` (
  `id` INT NOT NULL AUTO_INCREMENT COMMENT "用户 ID",
  `username` VARCHAR(30) NULL COMMENT "用户名称",
  `password` VARCHAR(20) NULL COMMENT "用户密码",
  `birthday` DATE NULL COMMENT "用户生日",
  PRIMARY KEY (`id`),
  UNIQUE INDEX `username_UNIQUE` (`username` ASC)
) COMMENT = "用户";

开开心心,执行命令,开始生成代码:

java -jar mybatis-generator-core-1.3.7.jar -configfile generatorConfig.xml -overwrite

然后查看生成的 Java 实体类:

看着这个注释,让我有点纠结啊 —— 为什么不是数据库中每个字段对应的注释呢?查找相关资料,得知 MBG 生成的是由 org.mybatis.generator.api.CommentGenerator 来控制的。这是一个接口,MBG 的默认实现类是 org.mybatis.generator.internal.DefaultCommentGenerator。当你在 generatorConfig.xml 中配置了 commentGenerator 标签,那么默认状态下,生成注释的工作,将由 DefaultCommentGenerator来完成。 所以我们来查看下这个 DefaultCommentGenerator 的源码:

public class DefaultCommentGenerator implements CommentGenerator {
    // 属性,即配置在 commentGenerator 标签之内的 Property 标签
    private Properties properties;
    // 是否不生成日期
    private boolean suppressDate;
    // 是否不生成注释
    private boolean suppressAllComments;
    // 是否添加数据库内的注释
    private boolean addRemarkComments;
    // 日期的格式
    private SimpleDateFormat dateFormat;

    public DefaultCommentGenerator() {
        super();
        properties = new Properties();
        suppressDate = false;
        suppressAllComments = false;
        addRemarkComments = false;
    }

    @Override
    public void addConfigurationProperties(Properties properties) {
        this.properties.putAll(properties);

        suppressDate = isTrue(properties
                .getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
        
        suppressAllComments = isTrue(properties
                .getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));

        addRemarkComments = isTrue(properties
                .getProperty(PropertyRegistry.COMMENT_GENERATOR_ADD_REMARK_COMMENTS));
        
        String dateFormatString = properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_DATE_FORMAT);
        if (StringUtility.stringHasValue(dateFormatString)) {
            dateFormat = new SimpleDateFormat(dateFormatString);
        }
    }
    
    // 其他代码
    ...
}

addRemarkComments 这个属性,看来就是用来生成数据库注释用的 —— 好开心,那把它设置为 true 试试:


    
    
    
    
        
        

        
            
            
        
        
        ...
    

运行命令:

java -jar mybatis-generator-core-1.3.7.jar -configfile generatorConfig.xml -overwrite

数据库注释倒是拿到了,但是生成的一堆其他信息,看着实在是太扎眼了。查看源码,发现这些内容已经写死在 DefaultCommentGenerator 中了,没有办法自定义。

自己动手丰衣足食,我们为啥不自己写个类实现 CommentGenerator 接口,然后自定义自己想要的注释呢。查看 commentGenerator 的 DTD,发现正好 commentGenerator 有个 type 属性,可以用来指定自己的注释实现类:

观察 CommentGenerator 接口,发现里面的方法非常多,不仅包含了生成 Java 实体注释对应的方法,还包括了生成 XML 中注释的方法。所以我们先写一个默认的实现类,实现CommentGenerator 接口,但不做任何操作 —— 因为 DefaultCommentGenerator 本文已经存在了,为了避免混淆,就叫它EmptyCommentGenerator 吧。然后定义我们自己的注释类,MySQLCommentGenerator,继承 EmptyCommentGenerator,重写我们需要的方法:

public class MySQLCommentGenerator extends EmptyCommentGenerator {

    private Properties properties;

    public MySQLCommentGenerator() {
        properties = new Properties();
    }

    @Override
    public void addConfigurationProperties(Properties properties) {
        // 获取自定义的 properties
        this.properties.putAll(properties);
    }

    @Override
    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        String author = properties.getProperty("author");
        String dateFormat = properties.getProperty("dateFormat", "yyyy-MM-dd");
        SimpleDateFormat dateFormatter = new SimpleDateFormat(dateFormat);

        // 获取表注释
        String remarks = introspectedTable.getRemarks();

        topLevelClass.addJavaDocLine("/**");
        topLevelClass.addJavaDocLine(" * " + remarks);
        topLevelClass.addJavaDocLine(" *");
        topLevelClass.addJavaDocLine(" * @author " + author);
        topLevelClass.addJavaDocLine(" * @date " + dateFormatter.format(new Date()));
        topLevelClass.addJavaDocLine(" */");
    }

    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        // 获取列注释
        String remarks = introspectedColumn.getRemarks();
        field.addJavaDocLine("/**");
        field.addJavaDocLine(" * " + remarks);
        field.addJavaDocLine(" */");
    }
}

因为我们现在要使用到我们自己自定义的 CommentGenerator ,所以我们 通过代码的方式来操作 MBG:

public class Generator {

    public static void main( String[] args ) throws Exception {
        List warnings = new ArrayList<>();
        File configFile = new File("generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(true);
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);
    }

}

然后配置 generatorConfig.xml设置我们自己的注释生成器:





    
    

    
        ...
        
        
        
            
            
        
        
        ...
    

完整的 Maven 项目在 我的 GitHub。现在,我们运行主类 Generator,成功生成了数据库中的注释:

等等,好像有点不对劲!

类的注释怎么没有了!

想来应该是 JDBC 连接 MySQL 的时候需要添加什么属性才能获取表的注释,上网查询,发现是 useInformationSchema,需要将其设置为 true(看来 MBG 给自己的 DefaultCommentGenerator 开了小灶):





    
        ...
        
        
        
            
            
        

        
        
             
             
        
        
        ...
    

然后再次运行主类 Generator

成功的生成了类注释和字段注释~

我这里并没有处理注释是多行文本的情况 —— 留给有兴趣的读者吧~
小项目地址:https://github.com/mizhoux/mbg-comment

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/77265.html

相关文章

  • Java代码生成

    摘要:全自动代码生成器项目地址代码模版位于下可根据需要自行修改第一个模版是根据编写的若不适合可以自行修改模版或选择其他模版配置文件在下创建文件随意例如可创建多个配置文件内容如下填入数据库配置以及生成代码的包名模版文件映射用于自定义生成 全自动代码生成器mybatis-generator 项目地址 https://github.com/GitHub-Laziji/mybatis-generat...

    Amos 评论0 收藏0
  • 优于 swagger 的 java markdown 文档自动生成框架-01-入门使用

    摘要:很多项目不写文档,即使写文档,对于开发人员来说也是非常痛苦的。无法保证及时更新。是基于注解的文档生成工具。让文档的阅读者享受到等同于手写文档的体验。将信息的获取和生成区分开。基于原生的注释,尽可能的生成简介的文档。 设计初衷 节约时间 Java 文档一直是一个大问题。 很多项目不写文档,即使写文档,对于开发人员来说也是非常痛苦的。 不写文档的缺点自不用多少,手动写文档的缺点也显而易见:...

    RdouTyping 评论0 收藏0
  • MyBatis GeneratorMybatis代码生成

    摘要:一的官方资料官方文档源码二介绍大致的意思是可以帮助所有版本的和以上版本的生成代码。其中目前最新的版本可以使用。指定生成一系列对象的环境。定义了生成的注释形式。与生成的实体相关。生成接口和类以达到轻易使用生成的模型和映射文件的目的。 一:MyBatis Generator的官方资料 MyBatis Generator官方文档github源码:MyBatis Generator (MBG)...

    SimonMa 评论0 收藏0
  • 在springboot中使用Mybatis Generator的两种方式

    摘要:每个微服务仅关注于完成一件任务并很好地完成该任务。在一个微服务的开发过程中很可能只关注对单表的操作。本文将说到在的项目中如何去配置形式和配置类形式和使用以及生成代码的两种方式形式和注解形式,在中更推荐去使用注解的形式。 介绍 Mybatis Generator(MBG)是Mybatis的一个代码生成工具。MBG解决了对数据库操作有最大影响的一些CRUD操作,很大程度上提升开发效率。如果...

    Carl 评论0 收藏0
  • Spring+Mybatis脚手架的使用

    摘要:地址简单说明这是一个的脚手架项目,方便老鸟使用,新手学习。然后我们在中加入这张表里还有很多配置,你可以直接使用我的默认配置,往上面添加即可。结语当然我这里很多细节没有讲到,仅仅是简单的使用了一下,希望各位有心的读者可以自己动手搭建一下。 Github地址 https://github.com/1994/ssm-scaffold.git 简单说明 这是一个Spring4+Mybatis3...

    张率功 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<