{"id":10006893,"date":"2022-11-22T17:28:23","date_gmt":"2022-11-22T09:28:23","guid":{"rendered":"https:\/\/ityet.com\/?p=10006893"},"modified":"2022-11-22T17:28:23","modified_gmt":"2022-11-22T09:28:23","slug":"%e6%8a%8amybatis-generator%e7%94%9f%e6%88%90%e7%9a%84%e4%bb%a3%e7%a0%81%e5%8a%a0%e4%b8%8a%e6%83%b3%e8%a6%81%e7%9a%84%e6%b3%a8%e9%87%8a","status":"publish","type":"post","link":"https:\/\/itmax.cn\/?p=10006893","title":{"rendered":"\u628aMybatis Generator\u751f\u6210\u7684\u4ee3\u7801\u52a0\u4e0a\u60f3\u8981\u7684\u6ce8\u91ca"},"content":{"rendered":"
\u4f5c\u8005\uff1a\u738b\u5efa\u4e50<\/h5>\n

1 \u524d\u8a00<\/h3>\n

\u5728\u65e5\u5e38\u5f00\u53d1\u5de5\u4f5c\u4e2d\uff0c\u6211\u4eec\u7ecf\u5e38\u7528Mybatis Generator\u6839\u636e\u8868\u7ed3\u6784\u751f\u6210\u5bf9\u5e94\u7684\u5b9e\u4f53\u7c7b\u548cMapper\u6587\u4ef6\u3002\u4f46\u662fMybatis Generator\u9ed8\u8ba4\u751f\u6210\u7684\u4ee3\u7801\u4e2d\uff0c\u6ce8\u91ca\u5e76\u4e0d\u662f\u6211\u4eec\u60f3\u8981\u7684\uff0c\u6240\u4ee5\u4e00\u822c\u5728Generator\u914d\u7f6e\u6587\u4ef6\u4e2d\uff0c\u4f1a\u8bbe\u7f6e\u4e0d\u81ea\u52a8\u751f\u6210\u6ce8\u91ca\u3002\u5e26\u6765\u7684\u95ee\u9898\u5c31\u662f\u81ea\u52a8\u751f\u6210\u4ee3\u7801\u4e4b\u540e\uff0c\u6211\u4eec\u8fd8\u8981\u81ea\u5df1\u53bb\u7c7b\u6587\u4ef6\u4e2d\u628a\u6ce8\u91ca\u52a0\u4e0a\uff0c\u5982\u679c\u751f\u6210\u7684\u7c7b\u8f83\u5c11\u8fd8\u597d\uff0c\u5982\u679c\u6709\u751f\u6210\u5f88\u591a\u7c7b\u6587\u4ef6\uff0c\u81ea\u5df1\u52a0\u6ce8\u91ca\u662f\u4e00\u4ef6\u7e41\u7410\u7684\u5de5\u4f5c\u3002<\/p>\n

\u901a\u8fc7\u91cd\u5199Mybatis Generator\u7684CommentGenerator\u63a5\u53e3\uff0c\u53ef\u4ee5\u65b9\u4fbf\u5730\u751f\u6210\u81ea\u5df1\u60f3\u8981\u7684\u6ce8\u91ca\uff0c\u51cf\u5c11\u91cd\u590d\u5de5\u4f5c\u3002<\/p>\n

2 \u4f7f\u7528Java\u65b9\u5f0f\u6267\u884cMybatis Generator<\/h3>\n

2.1 IDEA\u4e2d\u65b0\u5efaMaven\u9879\u76ee<\/h4>\n

pom.xml\u4e2d\u5f15\u5165jar\u5305<\/p>\n

<?xml version="1.0" encoding="UTF-8"?>\n<project xmlns="http:\/\/maven.apache.org\/POM\/4.0.0"\n         xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\n         xsi:schemaLocation="http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd">\n    <modelVersion>4.0.0<\/modelVersion>\n\n    <groupId>org.example<\/groupId>\n    <artifactId>MyGenerator<\/artifactId>\n    <version>1.0-SNAPSHOT<\/version>\n\n    <properties>\n        <maven.compiler.source>8<\/maven.compiler.source>\n        <maven.compiler.target>8<\/maven.compiler.target>\n    <\/properties>\n\n    <dependencies>\n        <dependency>\n            <groupId>mysql<\/groupId>\n            <artifactId>mysql-connector-java<\/artifactId>\n            <version>8.0.16<\/version>\n        <\/dependency>\n        <dependency>\n            <groupId>org.mybatis.generator<\/groupId>\n            <artifactId>mybatis-generator-core<\/artifactId>\n            <version>1.3.7<\/version>\n        <\/dependency>\n    <\/dependencies>\n<\/project><\/code><\/pre>\n
2.2 \u521b\u5efageneratorConfig.xml<\/h4>\n
\u968f\u4fbf\u627e\u4e2a\u76ee\u5f55\u653e\uff0c\u6211\u653e\u5728src\/main\/resources\u76ee\u5f55\u4e0b<\/p>\n
<?xml version="1.0" encoding="UTF-8"?>\n<!DOCTYPE generatorConfiguration PUBLIC\n        "-\/\/mybatis.org\/\/DTD MyBatis Generator Configuration 1.0\/\/EN"\n        "http:\/\/mybatis.org\/dtd\/mybatis-generator-config_1_0.dtd">\n<generatorConfiguration>\n    <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple" >\n        <!-- \u751f\u6210\u7684 Java \u6587\u4ef6\u7684\u7f16\u7801 -->\n        <property name="javaFileEncoding" value="UTF-8"\/>\n        <!-- \u683c\u5f0f\u5316 Java \u4ee3\u7801 -->\n        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"\/>\n        <!-- \u683c\u5f0f\u5316 XML \u4ee3\u7801 -->\n        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"\/>\n        <commentGenerator>\n            <property name="suppressAllComments" value="false" \/>\n        <\/commentGenerator>\n        <!-- \u914d\u7f6e\u6570\u636e\u5e93\u8fde\u63a5 -->\n        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"\n                        connectionURL="URL"\n                        userId="user" password="password">\n            <!-- \u8bbe\u7f6e useInformationSchema \u5c5e\u6027\u4e3a true -->\n            <property name="useInformationSchema" value="true" \/>\n        <\/jdbcConnection>\n        <!-- \u751f\u6210\u5b9e\u4f53\u7684\u4f4d\u7f6e -->\n        <javaModelGenerator targetPackage="com.jd.bulk"\n                            targetProject="src\/main\/java">\n            <property name="enableSubPackages" value="true"\/>\n        <\/javaModelGenerator>\n        <!-- \u751f\u6210 Mapper XML \u7684\u4f4d\u7f6e -->\n        <sqlMapGenerator targetPackage="com.jd.bulk"\n                         targetProject="src\/main\/resources">\n            <property name="enableSubPackages" value="true"\/>\n        <\/sqlMapGenerator>\n        <!-- \u751f\u6210 Mapper \u63a5\u53e3\u7684\u4f4d\u7f6e -->\n        <javaClientGenerator type="XMLMAPPER"\n                             targetPackage="com.jd.bulk"\n                             targetProject="src\/main\/java">\n            <property name="enableSubPackages" value="true"\/>\n        <\/javaClientGenerator>\n        <!-- \u8bbe\u7f6e\u6570\u636e\u5e93\u7684\u8868\u540d\u548c\u5b9e\u4f53\u7c7b\u540d -->\n        <table tableName="worker" domainObjectName="Worker"\/>\n    <\/context>\n<\/generatorConfiguration><\/code><\/pre>\n
2.3 \u521b\u5efamain\u65b9\u6cd5\uff0c\u8fd0\u884cGenerator<\/h4>\n
public class Generator {\n\n    public static void main(String[] args) throws Exception {\n        List<String> warnings = new ArrayList<>(2);\n        ConfigurationParser cp = new ConfigurationParser(warnings);\n\n        File configFile = new File("src\/main\/resources\/generatorConfig.xml");\n        Configuration config = cp.parseConfiguration(configFile);\n\n        DefaultShellCallback callback = new DefaultShellCallback(true);\n\n        MyBatisGenerator = new MyBatisGenerator(config, callback, warnings);\n        myBatisGenerator.generate(null);\n    }\n}<\/code><\/pre>\n
\u8fd0\u884cmain\u65b9\u6cd5\uff0c\u751f\u6210\u9ed8\u8ba4\u6ce8\u91ca\u5982\u4e0b\uff0c\u5e76\u4e0d\u662f\u6211\u4eec\u60f3\u8981\u7684\u6ce8\u91ca\uff0c\u6240\u4ee5\u4e00\u822c\u4f1a\u914d\u7f6e\u4e3a\u6ce8\u91ca\u4e0d\u751f\u6210\uff1a<\/p>\n
\"\"<\/p>\n
2.4 \u5b9e\u73b0CommentGenerator\u63a5\u53e3<\/h4>\n
\u91cd\u5199\u4ee5\u4e0b\u65b9\u6cd5\uff0c\u81ea\u5b9a\u4e49\u6ce8\u91ca<\/p>\n
public class MySQLCommentGenerator implements CommentGenerator {\n    private final Properties properties;\n    public MySQLCommentGenerator() {\n        properties = new Properties();\n    }\n    @Override\n    public void addConfigurationProperties(Properties properties) {\n        \/\/ \u83b7\u53d6\u81ea\u5b9a\u4e49\u7684 properties\n        this.properties.putAll(properties);\n    }\n    \/**\n     * \u91cd\u5199\u7ed9\u5b9e\u4f53\u7c7b\u52a0\u7684\u6ce8\u91ca\n     *\/\n    @Override\n    public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {\n        String author = properties.getProperty("author");\n        String dateFormat = properties.getProperty("dateFormat", "yyyy-MM-dd");\n        SimpleDateFormat dateFormatter = new SimpleDateFormat(dateFormat);\n        \/\/ \u83b7\u53d6\u8868\u6ce8\u91ca\n        String remarks = introspectedTable.getRemarks();\n        topLevelClass.addJavaDocLine("\/**");\n        topLevelClass.addJavaDocLine(" * " + remarks);\n        topLevelClass.addJavaDocLine(" *");\n        topLevelClass.addJavaDocLine(" * @author " + author);\n        topLevelClass.addJavaDocLine(" * @date   " + dateFormatter.format(new Date()));\n        topLevelClass.addJavaDocLine(" *\/");\n    }\n    \/**\n     * \u91cd\u5199\u7ed9\u5b9e\u4f53\u7c7b\u5b57\u6bb5\u52a0\u7684\u6ce8\u91ca\n     *\/\n    @Override\n    public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {\n        \/\/ \u83b7\u53d6\u5217\u6ce8\u91ca\n        String remarks = introspectedColumn.getRemarks();\n        field.addJavaDocLine("\/**");\n        field.addJavaDocLine(" * " + remarks);\n        field.addJavaDocLine(" *\/");\n    }\n    \/**\n     * \u91cd\u5199\u7ed9\u5b9e\u4f53\u7c7bget\u65b9\u6cd5\u52a0\u7684\u6ce8\u91ca\n     *\/\n    @Override\n    public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {\n        \/\/ \u83b7\u53d6\u8868\u6ce8\u91ca\n        String remarks = introspectedColumn.getRemarks();\n        method.addJavaDocLine("\/**");\n        method.addJavaDocLine(" * " + method.getName());\n        method.addJavaDocLine(" *\/");\n    }<\/code><\/pre>\n
2.5 \u4fee\u6539generatorConfig.xml\u914d\u7f6e<\/h4>\n
\u5c06generatorConfig.xml\u6587\u4ef6\u4e2d\u7684commentGenerator\u505a\u5982\u4e0b\u4fee\u6539\uff0ctype\u5c5e\u6027\u9009\u62e9\u81ea\u5df1\u7684\u5b9e\u73b0\u7c7b<\/p>\n
<commentGenerator type="com.generator.MySQLCommentGenerator">\n    <property name="author" value="Your Name"\/>\n    <property name="dateFormat" value="yyyy\/MM\/dd"\/>\n<\/commentGenerator><\/code><\/pre>\n
\u8fd0\u884cmain\u65b9\u6cd5\uff0c\u751f\u6210\u6ce8\u91ca\u5982\u4e0b\uff1a<\/p>\n
\"\"<\/p>\n
3 \u4f7f\u7528Maven\u65b9\u5f0f\u6267\u884cMybatis Generator<\/h3>\n
Pom.xml\u6587\u4ef6\u4e2d\u589e\u52a0\u4ee5\u4e0b\u914d\u7f6e\uff0c\u9700\u8981\u5f15\u5165generator\u63d2\u4ef6\u65f6\uff0c\u4f9d\u8d56\u5b9e\u73b0CommentGenerator\u63a5\u53e3\u7684jar\u5305\uff0c\u8981\u5148\u628a\u81ea\u5df1\u7684jar\u5305install\u5230\u672c\u5730\u4ed3\u5e93\u3002<\/p>\n
\u5426\u5219\u4f1a\u62a5com.generator.MySQLCommentGenerator\u627e\u4e0d\u5230\uff0c\u5176\u4ed6\u914d\u7f6e\u540c\u4e0a\u3002<\/p>\n
<build>\n    <defaultGoal>compile<\/defaultGoal>\n    <plugins>\n        <plugin>\n            <groupId>org.mybatis.generator<\/groupId>\n            <artifactId>mybatis-generator-maven-plugin<\/artifactId>\n            <version>1.4.0<\/version>\n            <configuration>\n                <configurationFile>src\/main\/resources\/generatorConfig.xml<\/configurationFile>\n                <verbose>true<\/verbose>\n                <overwrite>true<\/overwrite>\n            <\/configuration>\n            <dependencies>\n                <!-- \u5176\u4ed6\u7684\u6570\u636e\u5e93\uff0c\u9700\u8981\u4fee\u6539\u4f9d\u8d56 -->\n                <dependency>\n                    <groupId>mysql<\/groupId>\n                    <artifactId>mysql-connector-java<\/artifactId>\n                    <version>8.0.16<\/version>\n                <\/dependency>\n                <!-- \u5f15\u7528\u5b9e\u73b0CommentGenerator\u63a5\u53e3\u7684jar\u5305 -->\n                <dependency>\n                    <groupId>org.example<\/groupId>\n                    <artifactId>MyGenerator<\/artifactId>\n                    <version>1.0-SNAPSHOT<\/version>\n                <\/dependency>\n            <\/dependencies>\n        <\/plugin>\n    <\/plugins><\/code><\/pre>\n
4 \u6e90\u7801\u5206\u6790<\/h3>\n
\u67e5\u770b\u6267\u884cMybatis Generator\u7684main\u65b9\u6cd5\uff0c\u4e3b\u8981\u5206\u4e3a\u4e24\u90e8\u5206\uff0c\u89e3\u6790\u6307\u5b9a\u7684\u914d\u7f6e\u6587\u4ef6\u4e0e\u8c03\u7528\u751f\u6210java\u6587\u4ef6\u548cMapper\u6587\u4ef6\u7684\u65b9\u6cd5<\/p>\n
\"\"<\/p>\n
4.1 \u89e3\u6790\u6307\u5b9a\u7684xml\u914d\u7f6e\u6587\u4ef6<\/h4>\n
\u8ddf\u8e2a\u89e3\u6790xml\u6587\u4ef6\u7684\u65b9\u6cd5cp.parseConfiguration(configFile)\u53d1\u73b0\uff0c\u5e95\u5c42\u4ee5Document\u5f62\u5f0f\u8bfb\u53d6xml\u6587\u4ef6\uff0c\u6839\u636e\u6807\u7b7e\u540d\u89e3\u6790\u5404\u6807\u7b7e\u5c5e\u6027\uff0c\u4fdd\u5b58\u5230Configuration\u5b9e\u4f8b\u4e2d\u3002<\/p>\n
\"\"<\/p>\n
\u5176\u4e2d\u89e3\u6790commentGenerator\u6807\u7b7e\u7684\u65b9\u6cd5parseCommentGenerator(context, childNode)\u4e2d\uff0c\u4f1a\u83b7\u53d6commentGenerator\u6807\u7b7e\u7684type\u5c5e\u6027\u503c\uff0c\u4e5f\u5c31\u662f\u81ea\u5b9a\u4e49\u7684\u201dcom.generator.MySQLCommentGenerator\u201d\u7c7b\uff0c\u653e\u5230Context\u5b9e\u4f8b\u4e2d\u3002<\/p>\n
\"\"<\/p>\n
4.2 \u8c03\u7528\u751f\u6210java\u6587\u4ef6\u548cMapper\u6587\u4ef6\u7684\u65b9\u6cd5<\/h4>\n
xml\u914d\u7f6e\u6587\u4ef6\u89e3\u6790\u5b8c\u6210\uff0c\u5f97\u5230Configuration\u5b9e\u4f8b\uff0c\u540e\u9762\u751f\u6210\u6587\u4ef6\u7684\u5de5\u4f5c\u90fd\u4f1a\u4eceConfiguration\u5b9e\u4f8b\u4e2d\u83b7\u53d6\u6240\u9700\u6570\u636e\u3002\u751f\u6210\u6587\u4ef6\u7684\u65b9\u6cd5\u4e3b\u8981\u6b65\u9aa4\u4e3a\uff1a1.\u8fde\u63a5\u6570\u636e\u5e93,\u67e5\u8be2\u8868\u4fe1\u606f\u4e0e\u5217\u4fe1\u606f\uff0c2.\u751f\u6210\u6587\u4ef6\u5185\u5bb9\uff0c3.\u5199\u5165\u751f\u6210\u6587\u4ef6\u3002<\/p>\n
\u5176\u4e2d\u751f\u6210\u6587\u4ef6\u5185\u5bb9\u65f6\uff0c\u4f1a\u6839\u636eContext\u7684type\u5c5e\u6027\u53cd\u5c04\u521b\u5efaMySQLCommentGenerator\u5b9e\u4f8b\uff0c\u7136\u540e\u8c03\u7528\u81ea\u5b9a\u4e49\u7684\u751f\u6210\u6ce8\u91ca\u65b9\u6cd5\u3002<\/p>\n
\u5982\uff1a\u751f\u6210\u5b9e\u4f53\u7c7b\u6587\u4ef6\u7684\u6ce8\u91ca\uff0c\u8c03\u7528addModelClassComment\u65b9\u6cd5<\/p>\n
\"\"<\/p>\n
\u751f\u6210\u5b57\u6bb5\u6ce8\u91ca\uff0c\u8c03\u7528addFieldComment\u65b9\u6cd5<\/p>\n
\"\"<\/p>\n
\u751f\u6210Get\u65b9\u6cd5\u6ce8\u91ca\uff0c\u8c03\u7528addGetterComment\u65b9\u6cd5<\/p>\n
\"\"<\/p>\n
\u5728\u8c03\u7528addModelClassComment\uff0caddFieldComment\uff0caddGetterComment\u7b49\u751f\u6210\u6ce8\u91ca\u7684\u65b9\u6cd5\u65f6\uff0c\u6267\u884c\u7684\u90fd\u662fMySQLCommentGenerator\u7c7b\u7684\u65b9\u6cd5\uff0c\u8fd9\u6837\u5c31\u5b9e\u73b0\u4e86\u751f\u6210\u81ea\u5b9a\u4e49\u6ce8\u91ca\u7684\u529f\u80fd\u3002<\/p>\n
5 \u603b\u7ed3<\/h3>\n
\u901a\u8fc7\u4f7f\u7528\u81ea\u5b9a\u4e49\u5b9e\u73b0CommentGenerator\u63a5\u53e3\uff0c\u8ba9\u81ea\u52a8\u751f\u6210\u7684\u4ee3\u7801\u52a0\u4e0a\u6211\u4eec\u60f3\u8981\u7684\u6ce8\u91ca\uff0c\u53ef\u4ee5\u7701\u53bb\u81ea\u5df1\u52a0\u6ce8\u91ca\u7684\u9ebb\u70e6\u3002<\/p>\n
\u4e0e\u4e00\u822c\u4f7f\u7528Mybatis Generator\u751f\u6210\u4ee3\u7801\u7684\u65b9\u5f0f\u4e00\u6837\uff0c\u591a\u5b9e\u73b0\u4e2a\u63a5\u53e3\u5373\u53ef\u3002  
\u4f7f\u7528Maven\u65b9\u5f0f\u8fd0\u884c\u65f6\uff0c\u9700\u8981\u5728pom.xml\u5f15\u5165\u63d2\u4ef6\u65f6\uff0c\u4f9d\u8d56\u81ea\u5df1jar\u5305\u3002<\/p>\n
https:\/\/segmentfault.com\/a\/1190000042860826<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
\u4f5c\u8005\uff1a\u738b\u5efa\u4e50 1 \u524d\u8a00 \u5728\u65e5\u5e38\u5f00\u53d1\u5de5\u4f5c\u4e2d\uff0c\u6211\u4eec\u7ecf\u5e38\u7528Mybatis Generator\u6839\u636e\u8868\u7ed3\u6784\u751f\u6210\u5bf9\u5e94\u7684\u5b9e\u4f53 […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[4],"tags":[],"class_list":["post-10006893","post","type-post","status-publish","format-standard","hentry","category-share"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/posts\/10006893","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=10006893"}],"version-history":[{"count":0,"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/posts\/10006893\/revisions"}],"wp:attachment":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=10006893"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=10006893"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=10006893"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}