自定义Mybatis Generator注释

最新推荐文章于 2024-01-12 21:03:51 发布
最新推荐文章于 2024-01-12 21:03:51 发布
阅读量539 收藏
点赞数
分类专栏： 数据库 分享 文章标签： mysql mybatis generator java
参考链接

mybatis-generator自定义注释生成
MyBatis GeneratorXML Configuration File Reference

自定义Mybatis Generator注释步骤

1、配置自己的mybatisGenerator.xml，位置存放在resources目录下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
  PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
  <!-- 路径必须为绝对路径 -->
  <classPathEntry location="{yourPathPrefix}/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar" />

  <!-- 指定生成的java文件的编码,没有直接生成到项目时中文可能会乱码 -->
  <property name="javaFileEncoding" value="UTF-8"/>

  <!-- 注释配置 -->
  <commentGenerator type="com.shuhaith.test.MybatisCommentGenerator">
    <property name="author" value="shuhaith"/>
    <property name="copyRightName" value="shuhaith.com"/>
  </commentGenerator>
  
  <context id="Mysql" targetRuntime="MyBatis3">
    <jdbcConnection driverClass="com.mysql.jdbc.Driver"
        connectionURL="jdbc:mysql://localhost:3306/test?characterEncoding=UTF-8&amp;useSSL=true"
        userId="shuhaith"
        password="root">
        <!-- 设置 useInformationSchema 属性为 true，生成注释时读取数据库中表的comment -->
        <property name="useInformationSchema" value="true"/>
    </jdbcConnection>

    <javaTypeResolver >
      <property name="forceBigDecimals" value="false" />
    </javaTypeResolver>
	<!-- targetProject路径必须为绝对路径 -->
    <javaModelGenerator targetPackage="com.shuhaith.test.model" targetProject="{yourProjectPath}/src/main/java">
      <property name="enableSubPackages" value="true" />
      <property name="trimStrings" value="true" />
    </javaModelGenerator>
    
    <!-- targetProject路径必须为绝对路径 -->
    <javaClientGenerator type="ANNOTATEDMAPPER" targetPackage="com.shuhaith.test.dao"  targetProject="{yourProjectPath}/src/main/java">
      <property name="enableSubPackages" value="true" />
    </javaClientGenerator>

    <!-- %为通配符，所有表都会生成，你也可以选择自定义的正则式 -->
    <table tableName="%" >
      <!-- 自动递增ID会在插入数据后随模型类的ID属性返回 -->
      <generatedKey column="ID" sqlStatement="Mysql" identity="true" />
    </table>
    
  </context>
</generatorConfiguration>

2、实现org.mybatis.generator.api.CommentGenerator接口，参考org.mybatis.generator.internal.DefaultCommentGenerator写自定义的MyCommentGenerator

/**
 * mybatis自定义注释实现
 * @author shuhaith
 **/
public class MyCommentGenerator implements CommentGenerator {

    private Properties properties = new Properties();
    private boolean suppressDate = false;
    private boolean suppressAllComments = false;
    private boolean addRemarkComments = false;
    private String dateFormatString;
    private Calendar calendar = Calendar.getInstance();
    private String author = "";
    private String copyRightName = "";

    public MybatisCommentGenerator() {
        dateFormatString =
                new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
    }
    
    /**
     * 添加配置信息，初始化该类中的私有变量
     * 该方法执行顺序仅次于构造方法
     */
    @Override
    public void addConfigurationProperties(Properties properties) {
        this.properties.putAll(properties);
        this.suppressDate = StringUtility.isTrue(properties.getProperty("suppressDate"));
        this.suppressAllComments = StringUtility.isTrue(properties.getProperty("suppressAllComments"));
        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
        this.author = properties.getProperty("author");
        this.copyRightName = properties.getProperty("copyRightName");
    }

    /**
     * 添加自定义javaDoc标签
     */
    protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
        javaElement.addJavaDocLine(" *");
        StringBuilder sb = new StringBuilder();
        sb.append(" * @author ").append(author);
        javaElement.addJavaDocLine(sb.toString());
        sb.setLength(0);
        if (markAsDoNotDelete) {
            javaElement.addJavaDocLine(" * do_not_delete_during_merge");
        }

        if (dateFormatString != null) {
            sb.append(" * @createTime ").append(dateFormatString);
        }

        javaElement.addJavaDocLine(sb.toString());
    }

    /**
     * Java属性注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        if (!this.suppressAllComments) {
            field.addJavaDocLine("/**");
            StringBuilder sb = new StringBuilder(" * ");
            sb.append(introspectedColumn.getRemarks());//表中注释
            field.addJavaDocLine(sb.toString());
            field.addJavaDocLine(" */");
        }
    }

    /**
     * Java属性注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
        if (!this.suppressAllComments) {
            StringBuilder sb = new StringBuilder();
            field.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());//没有注释使用表名代替
            field.addJavaDocLine(sb.toString());
            field.addJavaDocLine(" */");
        }
    }

    /**
     * java类注释
     */
    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
        addClassComment(innerClass, introspectedTable, false);
    }

    /**
     * java类注释
     */
    @Override
    public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean b) {
        if (!this.suppressAllComments) {
            StringBuilder sb = new StringBuilder();
            innerClass.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerClass.addJavaDocLine(sb.toString());
            this.addJavadocTag(innerClass, b);
            innerClass.addJavaDocLine(" */");
        }
    }

    /**
     * 枚举类注释
     */
    @Override
    public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
        if (!this.suppressAllComments) {
            StringBuilder sb = new StringBuilder();
            innerEnum.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerEnum.addJavaDocLine(sb.toString());
            this.addJavadocTag(innerEnum, false);
            innerEnum.addJavaDocLine(" */");
        }
    }

    /**
     * get方法注释
     */
    @Override
    public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        if (!this.suppressAllComments) {
            StringBuilder sb = new StringBuilder();
            method.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" *");
            sb.setLength(0);
            sb.append(" * @return ");
            sb.append(introspectedColumn.getActualColumnName());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" */");
        }
    }

    /**
     * set方法注释
     */
    @Override
    public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
        if (!this.suppressAllComments) {
            StringBuilder sb = new StringBuilder();
            method.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" *");
            sb.setLength(0);
            sb.append(" * @param ");
            sb.append(introspectedColumn.getActualColumnName());
            method.addJavaDocLine(sb.toString());
            method.addJavaDocLine(" */");
        }
    }

    /**
     * 通用方法注释
     */
    @Override
    public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
        if (!this.suppressAllComments) {
            StringBuilder sb = new StringBuilder();
            method.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            method.addJavaDocLine(sb.toString());
            this.addJavadocTag(method, false);
            method.addJavaDocLine(" */");
        }
    }

    /**
     * Java文件注释
     */
    @Override
    public void addJavaFileComment(CompilationUnit compilationUnit) {
        compilationUnit.addFileCommentLine("/*");
        compilationUnit.addFileCommentLine("* " + compilationUnit.getType().getShortName() + ".java");
        compilationUnit.addFileCommentLine("* Copyright ©2018-" + calendar.get(Calendar.YEAR) +
                " " + copyRightName);
        compilationUnit.addFileCommentLine("* @createTime " + dateFormatString +
                "");
        compilationUnit.addFileCommentLine("*/");
    }

    @Override
    public void addComment(XmlElement xmlElement) {

    }

    @Override
    public void addRootComment(XmlElement xmlElement) {

    }

    @Override
    public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

    }

    @Override
    public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {

    }

    @Override
    public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

    }

    @Override
    public void addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> set) {

    }

    @Override
    public void addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) {

    }
}

3、运行自定义注释类有多重方法，一种是用MBG运行，另一种使用本地main方法运行。第一种需要将MyCommentGenerator打包成jar并导入到本地Maven仓库再将其引入，比较麻烦，所以我这里选择第二种，使用本地方法。

public class MyCommentGeneratorTest{
	public static void main(String[] args) {
        try {
            List<String> warnings = new ArrayList<>();
            InputStream inputStream = ClassLoader.getSystemResourceAsStream("mybatisGenerator.xml");
            ConfigurationParser cp = new ConfigurationParser(warnings);
            Configuration config = cp.parseConfiguration(inputStream);
            DefaultShellCallback callback = new DefaultShellCallback(true);
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
            myBatisGenerator.generate(new VerboseProgressCallback());
            for (String warning : warnings)
                System.out.println(warning);
        } catch (IOException | SQLException | InterruptedException
                | InvalidConfigurationException | XMLParserException e) {
            e.printStackTrace();
        }
    }
}

4、运行main方法，可以看到model和dao包内已经有生成的模型类和数据操作类。

shuhaith
关注
专栏目录
Spring boot 配合 Mybatis generator 生成自定义注释(格式)
Orange软件的博客
12-02 2532
项目需求：由数据库表反向生成到实体类，Mybatis generator 自带的生成注释都是英文的，所以就需要我们自己来扩展啦~~~ 参考文章：https://www.jb51.net/article/148070.htm 本人在他写的上面进行修改扩展…emmmm… 先看下生成后的样子吧： 第一步：pom.xml &lt;?xml version="1.0" encoding="UTF-8"?&...
自定义注释的mybatis-generator-core-1.3.6.jar
06-15
自定义注释的mybatis-generator-core-1.3.6.jar, 可以带表字段注释的实体类
mybatis generator 自定义注释生成
10-26
mybatis generator 自定义注释，生成modle,mapper,xml 自定义生成字段注释。直接放在D盘下面，可以直接生成。支持中文表字段注释，全表自动生成。
mybatisgenerator自定义注释
hyhanyu的博客
10-29 933
一般在生成java bean的时候，希望把 sql中的备注信息全都生成出来。这时需要自己定义注释生成。写一个类继承 DefaultCommentGenerator 把DefaultCommentGenerator 然后对addFieldComment方法进行重写，并且把其他的加注解的方法根据需要是否添加，如果只希望在java bean上有注解存在，那么把期他方法不实现。 public v...
MyBatis Generator 自定义生成注释
weixin_34019929的博客
09-26 183
最近做项目，ORM 使用的是 MyBatis，为了偷懒，我自然而然的想到了使用 MyBatis Generator（MBG）来生成数据库表对应的实体代码和 Mapper 代码。于是做了如下的配置（对 MBG 配置不熟悉的同学可以参考 Mybatis Generator最完整配置详解）： <?xml version="1.0" enc...
mybatis-generator 自定义注释
println小强的博客
07-27 428
本文根据mybatis-generator 1.3.5编写，其他版本可以参考 生成注释关键在于重写mybatis-generator的CommentGenerator我这里只重写了model生成的注解方法，其他还没研究，model注解需要重写addFieldComment方法 @Override public void addFieldComment(Field field, Intr...
MyBatis积累(2)：Mybatis Generator 自定义注释
mingyuli的博客
02-17 796
`
自定义MyBatis Generator 注释配置教程
"MyBatis Generator 自定义生成注释的方法" 在开发过程中，MyBatis Generator (MBG) 是一个非常实用的工具，它能够自动生成数据库表对应的实体类、Mapper接口和XML配置文件，极大地提高了开发效率。然而，MBG默认...
MyBatis Generator 自定义生成注释的方法
08-26
MyBatis Generator 自定义生成注释的方法 MyBatis Generator 是一个基于 Java 的持久层框架，它能够根据数据库表结构生成对应的实体类、Mapper 接口和 XML 配置文件。MyBatis Generator 提供了强大的自定义功能，...
MyBatis Generator去掉生成的注解
09-01
这里，`com.yourpackage.YourCustomCommentGenerator`是你自定义的评论生成器类全名，你需要实现`org.mybatis.generator.api.CommentGenerator`接口并提供相应的注释生成逻辑。 总的来说，通过以上配置，你可以根据...
mybatis-generator自定义注释实现
一叶知秋hwb的博客
11-10 312
（一）、项目结构 （二）、引入Maven依赖 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schema...
MyBatis Generator自定义插件实现自定义Mapper
12-02
MyBatis Generator自定义插件实现自定义Mapper,方便代码复用。
mybatis逆向工程 自定义添加注解以及注释、mapper
09-23
mybatis逆向工程 自定义添加注解以及注释、mapper，对框架前期搭建相当实用
mybatis-generator-core-1.3.7和mybatis-generator-core-1.3.5
10-25
里面有mybatis-generator-core-1.3.7和mybatis-generator-core-1.3.5，已经增加PaginationPlugin类，方便generator生成分页代码。调用 <plugin type="org.mybatis.generator.plugins.PaginationPlugin"></plugin>，解决了解决Cannot instantiate object of type org.mybatis.generator.plugins异常，
MyBatis generator - 简单使用（3）- 自定义注释
mytt_10566的博客
04-26 2181
一、官方相关文档 github：https://github.com/mybatis/generator 文档：http://mybatis.org/generator/index.html 二、自定义注释 在上一篇博客（MyBatis generator - 简单使用（2）- 配置详解）的3.2节说过一个<commentGenerator>标签，用于自定义注释的生成。 MyBatis generator中默认的注释生成器：org.mybatis.generator.internal.De
mybatis-generator自定义注释生成
Carl_Zhang
01-16 1343
mybatis-generator自定义注释生成 当然首先你的工程中要有mybatis-generator-core这个jar包.相关pom如下: dependency> groupId>org.mybatis.generatorgroupId> artifactId>mybatis-generator-coreartifactId> version>1.3.5ve
【mybatis-generator】mybatis代码生成器generator，生成文件名自定义配置
最新发布
qq_35448165的博客
01-12 1745
在根据表名生成实体类时，其类名和字段名默认使用驼峰命名，比方说 CREATE_DATE，生成的属性名字就是createDate相关属性设置：但是表名有时候比较长，我们就想要自己定义生成的文件名。
Cannot instantiate object of type MyBatis3Simple
wwr12138333的博客
05-23 629
Cannot instantiate object of type MyBatis3Simple 我这问题上网找，大家给出的解决办法都是type没写上，但是我写了。。。 他还是报错。。 这个问题主要是mybatis-generator-core的版本太低了 改成1.3.7就好了。 如果还不行就把mybatis-generator-maven-plugin的版本也改成1.3.7试试。 我是跟着b站视频走的，当时因为mybatis-generator-core的版本是1.3.0的时候下面c3p0的依赖没法引进
MybatisGenerator自动生成代码 (带自定义注释)
热门推荐
qigc_0529的博客
06-15 3万+
说明: 适用于maven项目, mysql/oracle数据库, 开发工具: IDEA1.配置generatorConfig.xml&lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值