基于Java代码配置MyBatis Generator

使用MyBatis Generator生成器时,有时候没办法使用xml形式的配置文件,比如将Maven项目设置成pom打包方式(<packaging>pom</packaging>)!由于Maven的工作机制对于打包方式为pom的项目是不会输出jar包或war包和resources内容,所以放在resources目录下或放在源码目录下的xml文件就没法读取了,就算你在pom.xml文件中明确有如下配置也没有用的:

<build>
    <resources>
      <resource>
        <directory>src/main/java</directory>
        <includes>
          <include>**/*.properties</include>
          <include>**/*.yml</include>
          <include>**/*.xml</include>
        </includes>
      </resource>
      <resource>
        <directory>src/main/resources</directory>
        <includes>
          <include>**/*.properties</include>
          <include>**/*.yml</include>
          <include>**/*.xml</include>
        </includes>
      </resource>
    </resources>
  </build>

这个时候就会用到纯Java代码的MyBatis Generator配置,直接贴配置代码:

import org.mybatis.generator.config.*;

/**
 * 基于Java代码的MBG配置
 * Maven打包方式为POM的项目或模块(<packaging>pom</packaging>),resources目录的内容不会输出到类路径下,所以可以选择直接使用Java代码配置!
 *
 * @author 707669522@qq.com
 * @since 2020-06-13
 */
public class GeneratorConfig {
  public static Configuration getGeneratorConfig() {
    Context context = new Context(ModelType.CONDITIONAL);
    context.setId("simple");
    context.setTargetRuntime("MyBatis3Simple");

    /*添加属性*/
    context.addProperty("javaFileEncoding", "UTF-8");

    /*插件配置,这个是我自己的插件,没有自定义插件的同学可以不配这一节,删除即可*/
    PluginConfiguration pluginConfig = new PluginConfiguration();
    pluginConfig.setConfigurationType("com.xgclassroom.generator.GeneratorPlugin");
    context.addPluginConfiguration(pluginConfig);

    /*注释生成器配置*/
    CommentGeneratorConfiguration commentGeneratorConfig = new CommentGeneratorConfiguration();
    commentGeneratorConfig.addProperty("suppressAllComments", "true");
    context.setCommentGeneratorConfiguration(commentGeneratorConfig);

    /*JDBC连接信息配置*/
    JDBCConnectionConfiguration jdbcConnectionConfig = new JDBCConnectionConfiguration();
    jdbcConnectionConfig.setDriverClass("com.mysql.cj.jdbc.Driver");
    //注意代码配置中JDBC连接字符串中的参数分隔符不需要再像xml配置文件中那样使用转义符
    jdbcConnectionConfig.setConnectionURL("jdbc:mysql://localhost:3306/permission_center?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false");
    jdbcConnectionConfig.setUserId("xurm");
    jdbcConnectionConfig.setPassword("1qaz@WSX");
    jdbcConnectionConfig.addProperty("nullCatalogMeansCurrent", "true");//MySQL无法识别table标签中schema类的配置,所以在URL上指明目标数据库,并追加nullCatalogMeansCurrent属性为true
    jdbcConnectionConfig.addProperty("remarksReporting", "true");//针对oracle数据库无法读取表和字段备注
    jdbcConnectionConfig.addProperty("useInformationSchema", "true");//针对mysql数据库无法读取表和字段备注
    context.setJdbcConnectionConfiguration(jdbcConnectionConfig);

    /*Model生成器配置*/
    JavaModelGeneratorConfiguration javaModelGeneratorConfig = new JavaModelGeneratorConfiguration();
    javaModelGeneratorConfig.setTargetProject("permission/src/main/java");//目标项目(源码主路径)
    javaModelGeneratorConfig.setTargetPackage("com.xgclassroom.model");//目标包(Model类文件存放包)
    context.setJavaModelGeneratorConfiguration(javaModelGeneratorConfig);

    /*SqlMapper生成器配置(*Mapper.xml类文件),要javaClient生成器类型配合*/
    SqlMapGeneratorConfiguration sqlMapGeneratorConfig = new SqlMapGeneratorConfiguration();
    sqlMapGeneratorConfig.setTargetProject("permission/src/main/java");//目标项目(源码主路径)
    sqlMapGeneratorConfig.setTargetPackage("com.xgclassroom.mapper");//目标包(*Mapper.xml类文件存放包)
    context.setSqlMapGeneratorConfiguration(sqlMapGeneratorConfig);

    /*JavaClient生成器配置(*Mapper.java类文件)*/
    JavaClientGeneratorConfiguration javaClientGeneratorConfig = new JavaClientGeneratorConfiguration();
    javaClientGeneratorConfig.setConfigurationType("XMLMAPPER");//JavaClient生成器类型(主要有ANNOTATEDMAPPER、MIXEDMAPPER、XMLMAPPER,要Context的TargetRuntime配合)
    javaClientGeneratorConfig.setTargetProject("permission/src/main/java");//目标项目(源码主路径)
    javaClientGeneratorConfig.setTargetPackage("com.xgclassroom.mapper");//目标包(*Mapper.java类文件存放包)
    context.setJavaClientGeneratorConfiguration(javaClientGeneratorConfig);

    /*表生成配置*/
    TableConfiguration tableConfig = new TableConfiguration(context);
    tableConfig.setTableName("%");
    GeneratedKey generatedKey = new GeneratedKey("id", "JDBC", true, null);//设置主键列和生成方式
    tableConfig.setGeneratedKey(generatedKey);
    context.addTableConfiguration(tableConfig);

    Configuration config = new Configuration();
    config.addContext(context);

    return config;
  }
}

然后就是把MyBatis Generator调用过程中原本读取xml配置文件的地方换掉就可以了:

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.util.ArrayList;
import java.util.List;

/**
 * MyBatisGenerator代码生成器Java调用程序
 *
 * @author 707669522@qq.com
 * @since 2020-06-13
 */
public class GeneratorRunner {
  public static void main(String[] args) {
    try {
      List<String> warnings = new ArrayList<String>();
      Configuration config;
      //使用xml配置文件的方式
      /*File configFile = new File(GeneratorRunner.class.getClassLoader().getResource("generatorConfig.xml").getPath());
      ConfigurationParser cp = new ConfigurationParser(warnings);
      config = cp.parseConfiguration(configFile);*/
      //使用纯Java代码配置的方式
      config = GeneratorConfig.getGeneratorConfig();
      DefaultShellCallback callback = new DefaultShellCallback(true);
      MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
      myBatisGenerator.generate(null);
    } catch (Exception e) {
      System.out.println(e.getMessage());
      e.printStackTrace();
    }
  }
}

最后把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="simple" targetRuntime="MyBatis3Simple">
    <property name="javaFileEncoding" value="UTF-8"/>
    <plugin type="com.xgclassroom.generator.GeneratorPlugin"></plugin>
    <commentGenerator>
      <property name="suppressAllComments" value="true"/>
    </commentGenerator>
    <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/customer_center?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false"
            userId="xurm" password="1qaz@WSX">
      <!--MySQL无法识别table标签中schema类的配置,所以在URL上指明目标数据库,并追加nullCatalogMeansCurrent属性为true-->
      <property name="nullCatalogMeansCurrent" value="true"></property>
      <!-- /*针对oracle数据库无法读取表和字段备注*/ -->
      <property name="remarksReporting" value="true"></property>
      <!-- /*针对mysql数据库无法读取表和字段备注*/ -->
      <property name="useInformationSchema" value="true"></property>
    </jdbcConnection>

    <javaModelGenerator targetPackage="com.xgclassroom.model" targetProject="customer/src/main/java"/>

    <sqlMapGenerator targetPackage="com.xgclassroom.mapper" targetProject="customer/src/main/java"></sqlMapGenerator>
    <javaClientGenerator type="XMLMAPPER" targetPackage="com.xgclassroom.mapper"
               targetProject="customer/src/main/java"/>
    <!--对于MySQL不要加schema和catalog,会生成{catalog}..{table}的SQL语句,表名填%是表示生成目标库的所有表-->
    <table tableName="%">
      <!--指定生成主键列相关的设置-->
      <generatedKey column="id" sqlStatement="JDBC"/>
    </table>
  </context>
</generatorConfiguration>

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

时间: 2020-06-16

Java框架搭建之Maven、Mybatis、Spring MVC整合搭建(图文)

本文主要介绍了Java框架搭建之Maven.Mybatis.Spring MVC整合搭建(图文),分享给大家,具体如下: SSM(Spring+SpringMVC+Mybatis),目前较为主流的企业级架构方案.标准的MVC设计模式,将整个系统划分为显示层.Controller层.Service层.Dao层四层,使用SpringMVC负责请求的转发和视图管理,Spring实现业务对象管理, MyBatis作为数据对象持久化引擎. 框架详情 Spring 是一个轻量级的Java开发框架,它是为了解

如何解决Mybatis--java.lang.IllegalArgumentException: Result Maps collection already contains value for X

这两天因为项目需要整合spring.struts2.mybatis三大框架,但启动的时候总出现这个错误,困扰我好久,在网上找到的答案都不是我想要的,今天终于知道原因了. user-mapper.xml如下: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http:/

Java如何利用Mybatis进行数据权限控制详解

前言 权限控制主要分为两块,认证(Authentication)与授权(Authorization).认证之后确认了身份正确,业务系统就会进行授权,现在业界比较流行的模型就是RBAC(Role-Based Access Control).RBAC包含为下面四个要素:用户.角色.权限.资源.用户是源头,资源是目标,用户绑定至角色,资源与权限关联,最终将角色与权限关联,就形成了比较完整灵活的权限控制模型. 资源是最终需要控制的标的物,但是我们在一个业务系统中要将哪些元素作为待控制的资源呢?我将系统中

mybatis如何使用Java8的日期LocalDate和LocalDateTime详解

前言 相信大家应该都知道,在实体Entity里面,可以使用java.sql.Date.java.sql.Timestamp.java.util.Date来映射到数据库的date.timestamp.datetime等字段 但是,java.sql.Date.java.sql.Timestamp.java.util.Date这些类都不好用,很多方法都过时了. Java8里面新出来了一些API,LocalDate.LocalTime.LocalDateTime 非常好用 默认的情况下,在mybatis

Mybatis单个参数的if判断报异常There is no getter for property named 'xxx' in 'class java.lang.Integer'的解决方案

我们都知道mybatis在进行参数判断的时候,直接可以用<if test=""></if> 就可以了,如下: 1.常规代码 <update id="update" parameterType="com.cq2022.zago.order.entity.Test" > update t_test_l <set > <if test="trnsctWayId != null"

Java使用MyBatis框架分页的5种方式

本文为大家分享了Java使用MyBatis框架分页的五种方式,供大家参考,具体内容如下 初始准备 1.创建分页对象类,方便模块间传值 //PageInfo.java import lombok.Data; @Data public class PageInfo { private int pageNo; private int pageSize; } 2.定义DAO层接口 import org.apache.ibatis.session.RowBounds; import org.springf

Java的MyBatis框架中Mapper映射配置的使用及原理解析

Mapper的内置方法 model层就是实体类,对应数据库的表.controller层是Servlet,主要是负责业务模块流程的控制,调用service接口的方法,在struts2就是Action.Service层主要做逻辑判断,Dao层是数据访问层,与数据库进行对接.至于Mapper是mybtis框架的映射用到,mapper映射文件在dao层用. 下面是介绍一下Mapper的内置方法: 1.countByExample ===>根据条件查询数量 int countByExample(UserE

MyBatis创建存储过程的实例代码_动力节点Java学院整理

所需要用到的其他工具或技术: 项目管理工具 : Maven 测试运行工具 : Junit 数据库 : Derby 本节需要用到的有2部分,第一部分是如何在Derby中创建存储过程,第二部分是如何在Mybatis中调用存储过程 一. 在Derby中创建存储过程 在Eclipse中创建一个新的普通Java项目命名为Test_Store_Procedure 在com.bjpowernode.practice包下创建一个Class命名为StoreProcedureOperationClass.class

java 中MyBatis注解映射的实例详解

java  中MyBatis注解映射的实例详解 1.普通映射 @Select("select * from mybatis_Student where id=#{id}") public Student getStudent(int id); @Insert("insert into mybatis_Student (name, age, remark, pic,grade_id,address_id) values (#{name},#{age},#{remark}, #{

详解Java MyBatis 插入数据库返回主键

最近在搞一个电商系统中由于业务需求,需要在插入一条产品信息后返回产品Id,刚开始遇到一些坑,这里做下笔记,以防今后忘记. 类似下面这段代码一样获取插入后的主键 User user = new User(); user.setUserName("chenzhou"); user.setPassword("xxxx"); user.setComment("测试插入数据返回主键功能"); System.out.println("插入前主键为:

MyBatis插入数据返回主键的介绍

Service层: public int addUser(UserDomian user){ int i = userMapper.insert(user); } xml: <insert id="insert" parameterType="....UserDomain"> insert into t_user(user_name,password) values (#{userName},#{password}) </insert> 这样

Mybatis批量插入数据返回主键的实现

响应效果(id为主键): { "data": [ {"studentName": "张三","classNo": "一班","id": 111}, {"studentName": "李四","classNo": "二班","id": 112}, {"studentName&quo

详解Java使用sqlite 数据库如何生成db文件

Java 使用Sqllite 数据库如何生成db文件            本文主要介绍Java 使用Sqllite 数据库如何生成db文件的实现实例,网上资料不是很多,自己上网搜资料看到的一个实例,希望可以帮助到读者 实现代码: import java.sql.Connection; import java.sql.PreparedStatement; import java.sql.ResultSet; import javax.sql.DataSource; import org.apac

详解Java的MyBatis框架中SQL语句映射部分的编写

1.resultMap SQL 映射XML 文件是所有sql语句放置的地方.需要定义一个workspace,一般定义为对应的接口类的路径.写好SQL语句映射文件后,需要在MyBAtis配置文件mappers标签中引用,例如: <mappers> <mapper resource="com/liming/manager/data/mappers/UserMapper.xml" /> <mapper resource="com/liming/mana

详解Java的MyBatis框架中动态SQL的基本用法

有些时候,sql语句where条件中,需要一些安全判断,例如按某一条件查询时如果传入的参数是空,此时查询出的结果很可能是空的,也许我们需要参数为空时,是查出全部的信息.使用Oracle的序列.mysql的函数生成Id.这时我们可以使用动态sql.下文均采用mysql语法和函数(例如字符串链接函数CONCAT). selectKey 标签 在insert语句中,在Oracle经常使用序列.在MySQL中使用函数来自动生成插入表的主键,而且需要方法能返回这个生成主键.使用myBatis的select

MyBatis在insert插入操作时返回主键ID的配置(推荐)

很多时候,在向数据库插入数据时,需要保留插入数据的id,以便进行后续的update操作或者将id存入其他表作为外键. 但是,在默认情况下,insert操作返回的是一个int值,并且不是表示主键id,而是表示当前SQL语句影响的行数... 接下来,我们看看MyBatis如何在使用MySQL和Oracle做insert插入操作时将返回的id绑定到对象中. MySQL用法: <insert id="insert" parameterType="com.test.User&qu

详解JAVA生成将图片存入数据库的sql语句实现方法

详解JAVA生成将图片存入数据库的sql语句实现方法 实现代码: 注释很清楚,不在重述~ public class Image2Hex { public static void main(String[] args) { try{ //存放图片的文件夹 File list = new File("d:/qmx"); File[] lists = list.listFiles(); String name; //生成的语句存放文件 PrintWriter pw = new PrintWr

MyBatis中insert操作返回主键的实现方法

在使用MyBatis做持久层时,insert语句默认是不返回记录的主键值,而是返回插入的记录条数:如果业务层需要得到记录的主键时,可以通过配置的方式来完成这个功能 针对Sequence主键而言,在执行insert sql前必须指定一个主键值给要插入的记录,如Oracle.DB2,可以采用如下配置方式: <insert id="add" parameterType="vo.Category"> <selectKey resultType="

详解 Java中日期数据类型的处理之格式转换的实例

详解 Java中日期数据类型的处理之格式转换的实例 概要: 日期以及时间格式处理,在Java中时间格式一般会涉及到的数据类型包括Calendar类和Date类. Date类: 1.Date类型转String类型(以时间格式1970-01-01 01:01:01为例) //yyyy-MM-dd HH:mm:ss表示24时间进制 SimpleDateFormat sDateFormat=new SimpleDateFormat("yyyy-MM-dd hh:mm:ss"); String