摘要：最近做項目，使用的是，為了偷懶，我自然而然的想到了使用來生成數(shù)據(jù)庫表對應(yīng)的實體代碼和代碼。

最近做項目，ORM 使用的是 MyBatis，為了偷懶，我自然而然的想到了使用 MyBatis Generator（MBG）來生成數(shù)據(jù)庫表對應(yīng)的實體代碼和 Mapper 代碼。于是做了如下的配置（對 MBG 配置不熟悉的同學(xué)可以參考 Mybatis Generator最完整配置詳解）：

數(shù)據(jù)庫建庫建表的代碼：

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 = "用戶";

開開心心，執(zhí)行命令，開始生成代碼：

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

然后查看生成的 Java 實體類：

看著這個注釋，讓我有點糾結(jié)啊 —— 為什么不是數(shù)據(jù)庫中每個字段對應(yīng)的注釋呢？查找相關(guān)資料，得知 MBG 生成的是由 org.mybatis.generator.api.CommentGenerator 來控制的。這是一個接口，MBG 的默認(rèn)實現(xiàn)類是 org.mybatis.generator.internal.DefaultCommentGenerator。當(dāng)你在 generatorConfig.xml 中配置了 commentGenerator 標(biāo)簽，那么默認(rèn)狀態(tài)下，生成注釋的工作，將由 DefaultCommentGenerator來完成。 所以我們來查看下這個 DefaultCommentGenerator 的源碼：

public class DefaultCommentGenerator implements CommentGenerator {
    // 屬性，即配置在 commentGenerator 標(biāo)簽之內(nèi)的 Property 標(biāo)簽
    private Properties properties;
    // 是否不生成日期
    private boolean suppressDate;
    // 是否不生成注釋
    private boolean suppressAllComments;
    // 是否添加數(shù)據(jù)庫內(nèi)的注釋
    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 這個屬性，看來就是用來生成數(shù)據(jù)庫注釋用的 —— 好開心，那把它設(shè)置為 true 試試：

    
    
    
    
        
        

        
            
            
        
        
        ...
    

運(yùn)行命令：

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

數(shù)據(jù)庫注釋倒是拿到了，但是生成的一堆其他信息，看著實在是太扎眼了。查看源碼，發(fā)現(xiàn)這些內(nèi)容已經(jīng)寫死在 DefaultCommentGenerator 中了，沒有辦法自定義。

自己動手豐衣足食，我們?yōu)樯恫蛔约簩憘€類實現(xiàn) CommentGenerator 接口，然后自定義自己想要的注釋呢。查看 commentGenerator 的 DTD，發(fā)現(xiàn)正好 commentGenerator 有個 type 屬性，可以用來指定自己的注釋實現(xiàn)類：

觀察 CommentGenerator 接口，發(fā)現(xiàn)里面的方法非常多，不僅包含了生成 Java 實體注釋對應(yīng)的方法，還包括了生成 XML 中注釋的方法。所以我們先寫一個默認(rèn)的實現(xiàn)類，實現(xiàn)CommentGenerator 接口，但不做任何操作 —— 因為 DefaultCommentGenerator 本文已經(jīng)存在了，為了避免混淆，就叫它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(" */");
    }
}

因為我們現(xiàn)在要使用到我們自己自定義的 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設(shè)置我們自己的注釋生成器：

    
    

    
        ...
        
        
        
            
            
        
        
        ...
    

完整的 Maven 項目在 我的 GitHub。現(xiàn)在，我們運(yùn)行主類 Generator，成功生成了數(shù)據(jù)庫中的注釋：

等等，好像有點不對勁！

類的注釋怎么沒有了！

想來應(yīng)該是 JDBC 連接 MySQL 的時候需要添加什么屬性才能獲取表的注釋，上網(wǎng)查詢，發(fā)現(xiàn)是 useInformationSchema，需要將其設(shè)置為 true（看來 MBG 給自己的 DefaultCommentGenerator 開了小灶）：

    
        ...
        
        
        
            
            
        

        
        
             
             
        
        
        ...
    

然后再次運(yùn)行主類 Generator：

成功的生成了類注釋和字段注釋~

我這里并沒有處理注釋是多行文本的情況 —— 留給有興趣的讀者吧~
小項目地址：https://github.com/mizhoux/mbg-comment