總結：mybatis-generator兩種使用方式pom-plugin、main方法

時間 2019-11-29

標籤總結 mybatis generator 兩種使用方式 pom plugin main 方法欄目 MyBatis 简体版

原文原文鏈接

1. 使用Maven plugin生成

pom.xml

<?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:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.xiaows</groupId>
    <artifactId>app</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>app</name>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- ... -->
        <!-- mapper 不推薦使用 -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>1.2.4</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.4</version>
                <configuration>
                    <configurationFile>${basedir}/src/main/resources/mybatis-generator.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.46</version>
                    </dependency>
        			<!-- mapper 不推薦使用 -->
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper-generator</artifactId>
                        <version>1.0.0</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

</project>

複製代碼

src/main/resources/mybatis-generator.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>
    <context id="MysqlContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!--<plugin type="tk.mybatis.mapper.generator.MapperPlugin"> <property name="mappers" value="cn.xiaows.app.util.MyMapper"/> </plugin>-->

        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/mydb" userId="root" password="123456"/>

        <!-- 對於生成的entity所在包 -->
        <javaModelGenerator targetPackage="cn.xiaows.app.entity0" targetProject="src/main/java"/>
        <!-- 對於生成的mapper所在目錄 -->
        <sqlMapGenerator targetPackage="mapper0" targetProject="src/main/resources"/>
        <!-- 配置mapper對應的java映射 -->
        <javaClientGenerator targetPackage="cn.xiaows.app.dao0" targetProject="src/main/java" type="XMLMAPPER" />

		<table tableName="%"/><!-- 全部表 -->
        <!--<table tableName="company" mapperName="CompanyDao"/>-->
        <!--<table tableName="user" mapperName="UserDao"/>-->
        <!--...-->
    </context>
</generatorConfiguration>

複製代碼

生成命令： mybatis-generator:generate -f pom.xml

2. 使用main方法生成

pom.xml

<?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:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>cn.xiaows</groupId>
    <artifactId>app</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>app</name>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>

        <!-- mybatis-generator -->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.4</version>
            <scope>compile</scope>
            <optional>true</optional>
        </dependency>
        
        <!-- mapper 不推薦使用 -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper-spring-boot-starter</artifactId>
            <version>1.2.4</version>
        </dependency>
    </dependencies>

</project>

複製代碼

MybatisGeneratorMain.java

package cn.xiaows.app.util;

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.File;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

public class MybatisGeneratorMain {

	public static void main(String[] args) throws Exception {
		List<String> warnings = new ArrayList<>();
		ConfigurationParser cp = new ConfigurationParser(warnings);
		Configuration config = cp.parseConfiguration(new File("app-logs-web/src/main/resources/mybatis-generator.xml"));
		// Configuration config = cp.parseConfiguration(ClassLoader.getSystemResourceAsStream("mybatis-generator.xml"));
		DefaultShellCallback callback = new DefaultShellCallback(true);
		MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
		myBatisGenerator.generate(null);
		for (String warning : warnings) {
			System.out.println(warning);
		}
	}
}


複製代碼

mybatis-generator.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>
    <context id="MysqlContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!--<plugin type="tk.mybatis.mapper.generator.MapperPlugin"> <property name="mappers" value="cn.xiaows.app.util.MyMapper"/> </plugin>-->

        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/mydb" userId="root" password="123456">
        </jdbcConnection>

        <!-- 對於生成的entity所在包 -->
        <javaModelGenerator targetPackage="cn.xiaows.app.entity" targetProject="app-logs-web/src/main/java"/>
        <!-- 對於生成的mapper所在目錄 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="app-logs-web/src/main/resources"/>
        <!-- 配置mapper對應的java映射 -->
        <javaClientGenerator targetPackage="cn.xiaows.app.dao" targetProject="app-logs-web/src/main/java" type="XMLMAPPER" />

		<table tableName="%"/><!-- 全部表 -->
        <!--<table tableName="user" mapperName="UserDao"/>-->
        <!--<table tableName="project" mapperName="ProjectDao"/>-->
        <!--...-->
    </context>
</generatorConfiguration>

複製代碼

MyMapper.java

package cn.xiaows.app.util;

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

/** * 繼承本身的MyMapper * 特別注意，該接口不能被掃描到，不然會出錯 */
@Deprecated
public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> {

}

複製代碼

UserMapper.java

package cn.xiaows.app.dao;

import cn.xiaows.app.entity.User;
import java.util.List;

public interface UserMapper {
    /** * This method was generated by MyBatis Generator. * This method corresponds to the database table user * * @mbg.generated Sat Jan 05 19:19:00 CST 2019 */
    int deleteByPrimaryKey(Integer id);

    /** * This method was generated by MyBatis Generator. * This method corresponds to the database table user * * @mbg.generated Sat Jan 05 19:19:00 CST 2019 */
    int insert(User record);

    /** * This method was generated by MyBatis Generator. * This method corresponds to the database table user * * @mbg.generated Sat Jan 05 19:19:00 CST 2019 */
    User selectByPrimaryKey(Integer id);

    /** * This method was generated by MyBatis Generator. * This method corresponds to the database table user * * @mbg.generated Sat Jan 05 19:19:00 CST 2019 */
    List<User> selectAll();

    /** * This method was generated by MyBatis Generator. * This method corresponds to the database table user * * @mbg.generated Sat Jan 05 19:19:00 CST 2019 */
    int updateByPrimaryKey(User record);
}

複製代碼

UserMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.xiaows.app.dao.UserMapper">
  <resultMap id="BaseResultMap" type="cn.xiaows.app.entity.User">
    <!-- WARNING - @mbg.generated This element is automatically generated by MyBatis Generator, do not modify. This element was generated on Sat Jan 05 19:19:00 CST 2019. -->
    <id column="id" jdbcType="INTEGER" property="id" />
    <result column="name" jdbcType="VARCHAR" property="name" />
    <result column="age" jdbcType="INTEGER" property="age" />
  </resultMap>
  <delete id="deleteByPrimaryKey" parameterType="java.lang.Integer">
    <!-- WARNING - @mbg.generated This element is automatically generated by MyBatis Generator, do not modify. This element was generated on Sat Jan 05 19:19:00 CST 2019. -->
    delete from user
    where id = #{id,jdbcType=INTEGER}
  </delete>
  <insert id="insert" parameterType="cn.xiaows.app.entity.User">
    <!-- WARNING - @mbg.generated This element is automatically generated by MyBatis Generator, do not modify. This element was generated on Sat Jan 05 19:19:00 CST 2019. -->
    insert into user (id, name, age
      )
    values (#{id,jdbcType=INTEGER}, #{name,jdbcType=VARCHAR}, #{age,jdbcType=INTEGER}
      )
  </insert>
  <update id="updateByPrimaryKey" parameterType="cn.xiaows.app.entity.User">
    <!-- WARNING - @mbg.generated This element is automatically generated by MyBatis Generator, do not modify. This element was generated on Sat Jan 05 19:19:00 CST 2019. -->
    update user
    set name = #{name,jdbcType=VARCHAR},
      age = #{age,jdbcType=INTEGER}
    where id = #{id,jdbcType=INTEGER}
  </update>
  <select id="selectByPrimaryKey" parameterType="java.lang.Integer" resultMap="BaseResultMap">
    <!-- WARNING - @mbg.generated This element is automatically generated by MyBatis Generator, do not modify. This element was generated on Sat Jan 05 19:19:00 CST 2019. -->
    select id, name, age
    from user
    where id = #{id,jdbcType=INTEGER}
  </select>
  <select id="selectAll" resultMap="BaseResultMap">
    <!-- WARNING - @mbg.generated This element is automatically generated by MyBatis Generator, do not modify. This element was generated on Sat Jan 05 19:19:00 CST 2019. -->
    select id, name, age
    from user
  </select>
</mapper>

複製代碼

springboot啓動類：AppLogApplication.java

package cn.xiaows.app;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
// import tk.mybatis.spring.annotation.MapperScan;// 不推薦使用 容易搞混!!!

/** 若是dao.UserMapper extends MyMapper<User> dao.UserMapper就不須要添加@org.apache.ibatis.annotations.Mapper註解 就必須添加@tk.mybatis.spring.annotation.MapperScan("cn.xiaows.app.dao")該註解 若是dao.UserMapper沒有添加Mapper註解 則這裏須要添加MapperScan("cn.xiaows.app.dao") */
@SpringBootApplication
@MapperScan("cn.xiaows.app.dao")
public class AppLogApplication {

    public static void main(String[] args) {
        SpringApplication.run(AppLogsWebApplication.class, args);
    }

}

複製代碼