mybatis自学之路-01(逆向工程并自定义注释）

落日映苍穹つ 2023-02-16 04:06 35阅读 0赞

**目录**

1.配置文件generatorConfig.xml

2.注释生成设置类

3.启动类

--------------------

1.配置文件generatorConfig.xml

<?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="D:\document\eclipse_workspace\local_repository\local_repository\mysql\mysql-connector-java\5.1.18\mysql-connector-java-5.1.18.jar" />
    
    	<context id="default" targetRuntime="MyBatis3">
    
    		
    		<commentGenerator type="com.autocode.MyCommentGenerator">
    			<property name="suppressDate" value="true" />
                <property name="suppressAllComments" value="true" />
    		</commentGenerator>
    
    		
    		<jdbcConnection driverClass="com.mysql.jdbc.Driver"
    						connectionURL="jdbc:mysql:///springmvc" userId="root"
    						password="123456">
    		</jdbcConnection>
    
    
    		
    		
    		<javaTypeResolver>
    			<property name="forceBigDecimals" value="false" />
    		</javaTypeResolver>
    
    
    		
    		<javaModelGenerator targetPackage="com.module"
    							targetProject="src/main/java">
    
    			
    			<property name="enableSubPackages" value="false" />
    			
    			<property name="constructorBased" value="false" />
    			
    			<property name="trimStrings" value="true" />
    			
    			<property name="immutable" value="false" />
    		</javaModelGenerator>
    
    		
    		<sqlMapGenerator targetPackage="META-INF.mapper"
    						 targetProject="src/main/resources">
    			<property name="enableSubPackages" value="false" />
    		</sqlMapGenerator>
    
    		
    		<javaClientGenerator targetPackage="com.dao"
    							 targetProject="src/main/java" type="XMLMAPPER">
    			<property name="enableSubPackages" value="true" />
    		</javaClientGenerator>
    
    		<table tableName="employee" domainObjectName="Employee"
    			   enableCountByExample="false" enableUpdateByExample="false"
    			   enableDeleteByExample="false" enableSelectByExample="false"
    			   selectByExampleQueryId="false">
    		</table>
    
    	</context>
    </generatorConfiguration>

2.注释生成设置类

package com.autocoding;
    
    import org.mybatis.generator.api.IntrospectedColumn;
    import org.mybatis.generator.api.IntrospectedTable;
    import org.mybatis.generator.api.dom.java.*;
    import org.mybatis.generator.internal.DefaultCommentGenerator;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    import java.util.List;
    import java.util.Properties;
    
    /**
     * 备注设置
     * @author zq
     *
     */
    public class MyCommentGenerator extends DefaultCommentGenerator {
    
    	@SuppressWarnings("unused")
    	private Properties properties;
    	@SuppressWarnings("unused")
    	private Properties systemPro;
    	private boolean suppressDate;
    	private boolean suppressAllComments;
    	private String currentDateStr;
    
    	public MyCommentGenerator() {
    		super();
    		properties = new Properties();
    		systemPro = System.getProperties();
    		suppressDate = false;
    		suppressAllComments = false;
    		currentDateStr = (new SimpleDateFormat("yyyy-MM-dd hh:mm:ss")).format(new Date());
    	}
    
    	@Override
    	public void addFieldComment(Field field, IntrospectedTable introspectedTable,
    			IntrospectedColumn introspectedColumn) {
    		if (suppressAllComments) {
    			return;
    		}
    		StringBuilder sb = new StringBuilder();
    		field.addJavaDocLine("/**");
    		sb.append(" * ");
    		sb.append(introspectedColumn.getRemarks());
    		field.addJavaDocLine(sb.toString().replace("\n", " "));
    		field.addJavaDocLine(" */");
    	}
    	@Override
    	public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
    
    	}
    	@Override
    	public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
    
    		if (suppressAllComments) {
    			return;
    		}
    		StringBuilder sb = new StringBuilder();
    		sb.append("/**");
    		sb.append("\n");
    		sb.append("	 * ");
    		sb.append("\n");
    		sb.append("	 * @author zq" + "\n");
    		if (!suppressDate) {
    
    			sb.append("	 * @since " + currentDateStr + "\n");
    
    		}
    
    		List<Parameter> parameters = method.getParameters();
    
    		for (Parameter parameter : parameters) {
    
    			sb.append("	 * @param " + parameter.getName() + "\n");
    
    		}
    
    		sb.append("	 * @return " + method.getReturnType());
    		sb.append("\n" + "	 */");
    		method.addJavaDocLine(sb.toString());
    	}
    	@Override
    	public void addGetterComment(Method method, IntrospectedTable introspectedTable,
    			IntrospectedColumn introspectedColumn) {
    
    	}
    	@Override
    	public void addSetterComment(Method method, IntrospectedTable introspectedTable,
    			IntrospectedColumn introspectedColumn) {
    
    	}
    	@Override
    	public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
    
    		super.addClassComment(innerClass,introspectedTable,markAsDoNotDelete);
    	}
    	@Override
    	public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
    	}
    	//@Override
    	public void addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
    
    		StringBuilder sb = new StringBuilder();
    		sb.append("/**");
    		sb.append("\n");
    		sb.append("* ");
    		sb.append("\n");
    		sb.append("* @author zq" + "\n");
    		if (!suppressDate) {
    
    			sb.append("* @since " + currentDateStr + "\n");
    
    		}
    		sb.append("* 数据表" + introspectedTable.getFullyQualifiedTableNameAtRuntime() + "映射bean，由Mybaits自动生成工具生成");
    		sb.append("\n" + "*/");
    		topLevelClass.addJavaDocLine(sb.toString());
    
    	}
    
    	@Override
    	public void addJavaFileComment(CompilationUnit var1){
    
    		/*if (suppressAllComments) {
    			return;
    		}*/
    		StringBuilder sb = new StringBuilder();
    		sb.append("/**");
    		sb.append("\n");
    		sb.append("* ");
    		sb.append("\n");
    		sb.append("* @author zq" + "\n");
    		if (!suppressDate) {
    
    			sb.append("* @since " + currentDateStr + "\n");
    
    		}
    		sb.append("* 数据表映射bean，由Mybaits自动生成工具生成");
    		sb.append("\n" + "*/");
    		var1.addFileCommentLine(sb.toString());
    
    	}
    
    }

3.启动类

package com.autocoding;
    
    import org.mybatis.generator.api.MyBatisGenerator;
    import org.mybatis.generator.config.Configuration;
    import org.mybatis.generator.config.xml.ConfigurationParser;
    import org.mybatis.generator.internal.DefaultShellCallback;
    
    import java.io.InputStream;
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * 代码自动生成器
     * @author zq
     * mybatis逆向工程
     */
    public class MyBatisGeneratorRun {
    
    	 public static void main(String[] args) throws Exception{
    	        MyBatisGeneratorRun app = new MyBatisGeneratorRun();
    
    	        System.out.println(app.getClass().getResource("/").getPath());
    	        app.generator();
    	        System.out.println(System.getProperty("user.dir"));
    	    }
    
    	    public void generator() throws Exception{
    
    	        List<String> warnings = new ArrayList<String>();
    	        boolean overwrite = true;
    	        InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream("conf/generatorConfig.xml");
    	        ConfigurationParser cp = new ConfigurationParser(warnings);
    	        Configuration config = cp.parseConfiguration(resourceAsStream);
    	        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
    	        //MyBatisGenerator是逆向工程的核心类
    	        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
    	        myBatisGenerator.generate(null);
    
    	        for(String warning:warnings){
    	            System.out.println(warning);
    	        }
    	    }
    
    }