zoukankan      html  css  js  c++  java
  • MyBatis Generator使用记录

    spring boot 2.5.3

    Eclipse Version: 2021-03 (4.19.0)

    org.mybatis.generator:mybatis-generator-maven-plugin:1.4.0

    org.postgresql:postgresql

    --

    MyBatis强大的SQL数据库操作中间件;

    MyBatis Generator用来【根据数据库中已经存在的表】建立实体类、Mapper类和XML文件等。

    本文演示使用MyBatis Generator(使用PostgreSQL)。

    注意,使用MyBatis Generator的前提是——数据表已经建立好(半自动,这和 Spring Data JPA 不同,当然,更多的代码可以搞定这事儿)。

    建立S.B.项目,引入 mybatis、PostgreSQL 依赖:

    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>2.2.0</version>
    </dependency>
    
    <dependency>
      <groupId>org.postgresql</groupId>
      <artifactId>postgresql</artifactId>
      <scope>runtime</scope>
    </dependency>

    追加依赖包:

    <dependency>
    	<groupId>org.projectlombok</groupId>
    	<artifactId>lombok</artifactId>
    </dependency>

    启动,失败——因为依赖了 mybatis-spring-boot-starter。

    添加DataSource配置:

    # 本机PostgreSQL
    spring.datasource.url=jdbc:postgresql://localhost:5432/lib1
    spring.datasource.username=postgres
    spring.datasource.password=123456
    spring.datasource.driver-class-name=org.postgresql.Driver

    说明,如果只是使用MyBatis Generator建立一些Mapper文件,是不需要引入的。

    启动,成功。

    pom.xml添加 mybatis-generator-maven-plugin;合适的位置建立 generatorConfig.xml——本文是 src/main/resources/mbg 目录下

    // pom.xml
    <!-- mybatis generator 自动生成代码插件 -->
    <plugin>
    	<groupId>org.mybatis.generator</groupId>
    	<artifactId>mybatis-generator-maven-plugin</artifactId>
    	<version>1.4.0</version>
    	<configuration>
    		<configurationFile>${basedir}/src/main/resources/mbg/generatorConfig.xml</configurationFile>
    		<overwrite>true</overwrite>
    		<verbose>true</verbose>
    	</configuration>
    	<!-- 配置数据库链接及mybatis generator core依赖 生成mapper时使用 -->
    	<dependencies>
    		<dependency>
    			<groupId>org.postgresql</groupId>
    			<artifactId>postgresql</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.mybatis.generator</groupId>
    			<artifactId>mybatis-generator-core</artifactId>
    			<version>1.4.0</version>
    		</dependency>
    	</dependencies>
    </plugin>

    注意,Eclipse自动安装了mybatis-generator-maven-plugin插件:

    简单版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:\work\mvnrepo\org\postgresql\postgresql\42.2.23\postgresql-42.2.23.jar"/>
    	
        <context id="psqllib1" targetRuntime="MyBatis3">
            <!-- 数据库链接URL,用户名、密码 -->
            <jdbcConnection driverClass="org.postgresql.Driver"
                            connectionURL="jdbc:postgresql://localhost:5432/lib1"
                            userId="postgres"
                            password="123456">
            </jdbcConnection>
    
            <!-- 生成模型的包名和位置-->
            <javaModelGenerator targetPackage="org.zl.mybatis.use.model" targetProject="mybatis.use">
            </javaModelGenerator>
    
            <!-- 生成映射文件的包名和位置-->
            <sqlMapGenerator targetPackage="mapper" targetProject="mybatis.use">
            </sqlMapGenerator>
    
            <!-- 生成DAO的包名和位置 -->
            <javaClientGenerator type="XMLMAPPER" targetPackage="org.zl.mybatis.use.mapper" targetProject="mybatis.use">
            </javaClientGenerator>
    
            <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
            <table tableName="mbg_company" domainObjectName="Company">
            </table>
        </context>
    
    </generatorConfiguration>

    注意,这里的 targetProject 都是项目名,而不是很多示例中的 路径,否则会出现错误——Project src does not exist问题。

    注意,上面的<context>标签中的内容还不完整,后续有机会再补充。

    注意,上面的<context>标签中子元素的顺序不能错,否则,运行不了的。

    使用 MBG前目录结构:实体类、Mapper接口、Mapper.xml 都不存在。

    提前建立数据表(下面的脚本来自 pgAdmin工具建立的表):mbg_company

    建表脚本
    -- Table: public.mbg_company
    
    -- DROP TABLE public.mbg_company;
    
    CREATE TABLE IF NOT EXISTS public.mbg_company
    (
        id integer NOT NULL DEFAULT nextval('mbg_company_id_seq'::regclass),
        name_cn character varying(100)[] COLLATE pg_catalog."default" NOT NULL,
        name_en character varying(200)[] COLLATE pg_catalog."default",
        founding_time timestamp without time zone,
        founder character varying(100)[] COLLATE pg_catalog."default",
        create_date date,
        create_time timestamp without time zone,
        update_time timestamp without time zone,
        CONSTRAINT mbg_company_pkey PRIMARY KEY (id)
    )
    WITH (
        OIDS = FALSE
    )
    TABLESPACE pg_default;
    
    ALTER TABLE public.mbg_company
        OWNER to postgres;
    
    COMMENT ON TABLE public.mbg_company
        IS '测试MyBatis Generator的表。公司。';

    执行Mybatis Generator(generatorConfig.xml上 点击右键):

    执行后:什么都有了。

    奇怪的是,Mapper.xml 怎么跑到 src/main/java 去了?不应该放到 src/main/resources 吗?

    修改 sqlMapGenerator 的 targetProject 为 mybatis.use\src\main\resources,即可。

    删除后,再重新建立,文件位置符合预期了。

    其它问题:

    实体类中,预期为 字符串的nameCn、nameEn、founder 的类型变成了 Object?什么情况?

    原来,建表的时候,设置了长度为100,导致数据类型变为:character varying(200)[] —— 末尾还有一对 []!

    更改后,再次使用 MBG,问题得到解决。

    使用Mapper:

    1、使用 @MapperScans+@MapperScan

    2、建立 Mapper接口 和 Mapper.xml 文件的关联

    # application.properties
    mybatis.mapper-locations=classpath:/mapper/*.xml

    3、添加失败

    Caused by: org.postgresql.util.PSQLException: 错误: 在字段 "id" 中空值违反了非空约束
      详细:失败, 行包含(null, 阿里巴巴, null, null, 马云, null, null, null).
    
    Mapper.xml 中,insert 没有自动生成主键!需更改
      <insert id="insert" parameterType="org.zl.mybatis.use.model.Company">
        <!--
          WARNING - @mbg.generated
          This element is automatically generated by MyBatis Generator, do not modify.
          This element was generated on Mon Nov 22 21:45:16 CST 2021.
        -->
        insert into mbg_company (id, name_cn, name_en, 
          founding_time, founder, create_date, 
          create_time, update_time)
        values (#{id,jdbcType=INTEGER}, #{nameCn,jdbcType=VARCHAR}, #{nameEn,jdbcType=VARCHAR}, 
          #{foundingTime,jdbcType=TIMESTAMP}, #{founder,jdbcType=VARCHAR}, #{createDate,jdbcType=DATE}, 
          #{createTime,jdbcType=TIMESTAMP}, #{updateTime,jdbcType=TIMESTAMP})
      </insert>

    这个 实现不符合预期。

    @Component
    public class TestRunner implements CommandLineRunner {
    
    	@Autowired
    	private CompanyMapper cm;
    	
    	@Override
    	public void run(String... args) throws Exception {
    		System.out.println("cm=" + cm);
    		
    		Company c = new Company();
    		c.setNameCn("公司001");
    		c.setFounder("老板001");
    
    		// 失败
    //		int ret = cm.insert(c);
    		int ret = cm.insertSelective(c);
    		System.out.println("ret=" + ret + ", c=" + c);
    	}
    
    }
    

    把insert方法改为 insertSelective 时,数据添加成功了。

    但是,返回结果没有主键id的值:

    ret=1, c=Company(id=null, nameCn=公司001, nameEn=null, foundingTime=null, 
    founder=老板001, createDate=null, createTime=null, updateTime=null)

    更改<insert>标签后可以得到:

    <insert id="insertSelective" parameterType="org.zl.mybatis.use.model.Company" 
      		useGeneratedKeys="true" keyProperty="id">

    测试结果:id=3

    ret=1, c=Company(id=3, nameCn=公司001, nameEn=null, foundingTime=null, founder=老板001, 
    createDate=null, createTime=null, updateTime=null)

    数据添加完毕,第一步搞定。

    更多精彩,后续再补充。

    》》》未完待续《《《

    参考文档

    1、Mybatis自动生成实体代码的 generator 插件

    by 早起的年轻人

    2、spring boot 如何优雅的使用mybatis-spring-boot-starter

    by 每一天都可怜

    3、书《Mybatis从入门到精通》

    by 刘增辉

    4、

  • 相关阅读:
    搜索框用定时器限制发送请求
    vue的生命周期,钩子函数
    事件委托的实现流程
    在vscode中快速生成vue模板
    JS继承
    各种宽高
    ES6新特性
    python入门学习一
    字符编码
    npm install --save 与 npm install --save-dev 的区别
  • 原文地址:https://www.cnblogs.com/luo630/p/15590167.html
Copyright © 2011-2022 走看看