MyBatis Generator的使用

最新推荐文章于 2020-12-19 13:57:17 发布
最新推荐文章于 2020-12-19 13:57:17 发布
阅读量277 收藏
点赞数
分类专栏： javaweb 文章标签： mybatis Generator
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhong_ling/article/details/73608620
版权
  1. 安装MyBatis Generator插件

    下载MyBatis Generator插件插件包解压后将features、plugins文件夹下的架包分别拷贝到eclipse安装目录下的features、plugins文件夹。重启eclipse就行。下载地址: http://download.csdn.net/download/zhong_ling/9875417

  2. 创建generatorConfig.xml文件

    配置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 >
  <!-- 学习地址: http://mbg.cndocs.tk/ -->
  <classPathEntry  location="C:/Users/Window/.m2/repository/mysql/mysql-connector-java/5.1.29/mysql-connector-java-5.1.29.jar" />
  <context id="context1" >
      <!-- 分页插件 -->
    <plugin type="com.uitl.PaginationPlugin" />
    
    <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test" userId="root" password="root" />
    
    <!-- java模型创建器，是必须要的元素  负责：1，key类（见context的defaultModelType）；2，java类；
        3，查询类targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，则生成失败-->
    <javaModelGenerator targetPackage="com.model" targetProject="springMVC_mybaits" />
    
    <!-- 生成mapper.xml文件 -->
    <sqlMapGenerator targetPackage="com.mapping" targetProject="springMVC_mybaits" />
    
    <!-- 生成Mapper接口 -->
    <javaClientGenerator targetPackage="com.dao" targetProject="springMVC_mybaits" type="XMLMAPPER" />

    <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素 -->
    <table tableName="user" >
      <!-- 指定自增加以及Id  column:字段名, sqlStatement:数据库语句,可以为MySql，DB2,SqlServer,SyBase. identity:true为id，false不为id-->
      <generatedKey column="id" sqlStatement="Mysql"/>
      <!-- 将数据库中的字段重命名为实体类的属性 -->
      <!-- <columnOverride column="id" property="integer" /> -->
    </table>
  </context>
</generatorConfiguration>
  3. 创建好数据库表.
  4. 生成代码(注意指定的目录一定要存在,不然生成不了)右击generatorConfig.xml文件选择Generator MyBatis点击就可以生成代码了按上面所述的配置会在dao文件夹下生成UserMapper.java文件在mapping文件夹下面生成UserMapper.xml文件,在model文件夹下面生成UserExample.java和User.java文件.
  5. 以上的配置是生成不了带分页的查询的要自己扩展步骤如下

      引入要用到的jar包,在pom.xml加入下面代码

            <dependency>
	        <groupId>org.mybatis.generator</groupId>  
	        <artifactId>mybatis-generator-core</artifactId>  
	        <version>1.3.2</version>  
	        <type>jar</type>  
	        <scope>test</scope>  
        </dependency>
    然后写一个类继承PluginAdapter类,内容如下
    public class PaginationPlugin extends PluginAdapter
{

	@Override  
    public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,  
            IntrospectedTable introspectedTable) {  
        addLimit(topLevelClass, introspectedTable, "startRow");  
        addLimit(topLevelClass, introspectedTable, "endRow");
        return super.modelExampleClassGenerated(topLevelClass,  
                introspectedTable);
    }
    @Override  
    public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(  
            XmlElement element, IntrospectedTable introspectedTable) {  
        XmlElement isNotNullElement = new XmlElement("if");  
        isNotNullElement.addAttribute(new Attribute("test", "startRow != null and startRow >= 0")); 
        isNotNullElement.addElement(new TextElement(  
                "limit #{startRow} , #{endRow}"));  
        element.addElement(isNotNullElement);  
        return super.sqlMapUpdateByExampleWithoutBLOBsElementGenerated(element,  
                introspectedTable);  
    }
    private void addLimit(TopLevelClass topLevelClass,  
            IntrospectedTable introspectedTable, String name) {  
        CommentGenerator commentGenerator = context.getCommentGenerator();  
        Field field = new Field();
        field.setVisibility(JavaVisibility.PROTECTED);  
        field.setType(PrimitiveTypeWrapper.getIntegerInstance());  
        field.setName(name);  
        commentGenerator.addFieldComment(field, introspectedTable);  
        topLevelClass.addField(field);  
        char c = name.charAt(0);  
        String camel = Character.toUpperCase(c) + name.substring(1);  
        Method method = new Method();  
        method.setVisibility(JavaVisibility.PUBLIC);  
        method.setName("set" + camel);  
        method.addParameter(new Parameter(PrimitiveTypeWrapper.getIntegerInstance(), name));  
        method.addBodyLine("this." + name + "=" + name + ";");  
        commentGenerator.addGeneralMethodComment(method, introspectedTable);  
        topLevelClass.addMethod(method);  
        method = new Method();  
        method.setVisibility(JavaVisibility.PUBLIC);  
        method.setReturnType(PrimitiveTypeWrapper.getIntegerInstance());  
        method.setName("get" + camel);  
        method.addBodyLine("return " + name + ";");
        commentGenerator.addGeneralMethodComment(method, introspectedTable);  
        topLevelClass.addMethod(method);  
    }
    public boolean validate(List<String> warnings) {  
        return true;  
    }  


  
}

    在generatorConfig.xml文件中加入
    <plugin type="插件位置" />
    如上面generatorConfig.xml文件中注释掉的
      	<!-- 分页插件 -->
    <!--<plugin type="com.uitl.PaginationPlugin" /> -->
    再去生成的话就可以生成带分页的代码了.

    以上就是使用的全部内容了.不过感觉生成的内容挺多都重复了所以个人觉得可以把生成后的代码整理一下把公用的部分封装一下.主要是XXXExample.java文件和XXXMapper.java文件.以下是整理后的XXXExample.java
    public class BaseExample {
	
    protected String orderByClause;

    protected boolean distinct;

    protected List<Criteria> oredCriteria;
    
    protected Integer startRow;

    protected Integer endRow;

    public BaseExample() {
        oredCriteria = new ArrayList<Criteria>();
    }

    public void setOrderByClause(String orderByClause) {
        this.orderByClause = orderByClause;
    }

    public String getOrderByClause() {
        return orderByClause;
    }

    public void setDistinct(boolean distinct) {
        this.distinct = distinct;
    }

    public boolean isDistinct() {
        return distinct;
    }

    public List<Criteria> getOredCriteria() {
        return oredCriteria;
    }

    public void or(Criteria criteria) {
        oredCriteria.add(criteria);
    }

    public Criteria or() {
        Criteria criteria = createCriteriaInternal();
        oredCriteria.add(criteria);
        return criteria;
    }

    public Criteria createCriteria() {
        Criteria criteria = createCriteriaInternal();
        if (oredCriteria.size() == 0) {
            oredCriteria.add(criteria);
        }
        return criteria;
    }

    protected Criteria createCriteriaInternal() {
        Criteria criteria = new Criteria();
        return criteria;
    }

    public void clear() {
        oredCriteria.clear();
        orderByClause = null;
        distinct = false;
    }

    public void setStartRow(Integer startRow) {
        this.startRow=startRow;
    }

    public Integer getStartRow() {
        return startRow;
    }

    public void setEndRow(Integer endRow) {
        this.endRow=endRow;
    }

    public Integer getEndRow() {
        return endRow;
    }

    protected abstract static class GeneratedCriteria {
        protected List<Criterion> criteria;

        protected GeneratedCriteria() {
            super();
            criteria = new ArrayList<Criterion>();
        }

        public boolean isValid() {
            return criteria.size() > 0;
        }

        public List<Criterion> getAllCriteria() {
            return criteria;
        }

        public List<Criterion> getCriteria() {
            return criteria;
        }

        protected void addCriterion(String condition) {
            if (condition == null) {
                throw new RuntimeException("Value for condition cannot be null");
            }
            criteria.add(new Criterion(condition));
        }

        protected void addCriterion(String condition, Object value, String property) {
            if (value == null) {
                throw new RuntimeException("Value for " + property + " cannot be null");
            }
            criteria.add(new Criterion(condition, value));
        }

        protected void addCriterion(String condition, Object value1, Object value2, String property) {
            if (value1 == null || value2 == null) {
                throw new RuntimeException("Between values for " + property + " cannot be null");
            }
            criteria.add(new Criterion(condition, value1, value2));
        }

        
        
        public Criteria andFieldNameIsNull(String fieldName) {
            addCriterion(""+fieldName+" is null");
            return (Criteria) this;
        }

        public Criteria andFieldNameIsNotNull(String fieldName) {
            addCriterion(""+fieldName+" is not null");
            return (Criteria) this;
        }

        public Criteria andFieldNameEqualTo(Object value,String fieldName) {
            addCriterion(""+fieldName+" =", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameNotEqualTo(Object value,String fieldName) {
            addCriterion(""+fieldName+" <>", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameGreaterThan(Object value,String fieldName) {
            addCriterion(""+fieldName+" >", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameGreaterThanOrEqualTo(Object value,String fieldName) {
            addCriterion(""+fieldName+" >=", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameLessThan(Object value,String fieldName) {
            addCriterion(""+fieldName+" <", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameLessThanOrEqualTo(Object value,String fieldName) {
            addCriterion(""+fieldName+" <=", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameLike(Object value,String fieldName) {
            addCriterion(""+fieldName+" like", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameNotLike(Object value,String fieldName) {
            addCriterion(""+fieldName+" not like", value, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameIn(List<Object> values,String fieldName) {
            addCriterion(""+fieldName+" in", values, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameNotIn(List<Object> values,String fieldName) {
            addCriterion(""+fieldName+" not in", values, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameBetween(Object value1, Object value2,String fieldName) {
            addCriterion(" "+fieldName+" between", value1, value2, fieldName);
            return (Criteria) this;
        }

        public Criteria andFieldNameNotBetween(Object value1, Object value2,String fieldName) {
            addCriterion(" "+fieldName+" not between", value1, value2, fieldName);
            return (Criteria) this;
        }
    }

    public static class Criteria extends GeneratedCriteria {

        protected Criteria() {
            super();
        }
    }

    public static class Criterion {
        private String condition;

        private Object value;

        private Object secondValue;

        private boolean noValue;

        private boolean singleValue;

        private boolean betweenValue;

        private boolean listValue;

        private String typeHandler;

        public String getCondition() {
            return condition;
        }

        public Object getValue() {
            return value;
        }

        public Object getSecondValue() {
            return secondValue;
        }

        public boolean isNoValue() {
            return noValue;
        }

        public boolean isSingleValue() {
            return singleValue;
        }

        public boolean isBetweenValue() {
            return betweenValue;
        }

        public boolean isListValue() {
            return listValue;
        }

        public String getTypeHandler() {
            return typeHandler;
        }

        protected Criterion(String condition) {
            super();
            this.condition = condition;
            this.typeHandler = null;
            this.noValue = true;
        }

        protected Criterion(String condition, Object value, String typeHandler) {
            super();
            this.condition = condition;
            this.value = value;
            this.typeHandler = typeHandler;
            if (value instanceof List<?>) {
                this.listValue = true;
            } else {
                this.singleValue = true;
            }
        }

        protected Criterion(String condition, Object value) {
            this(condition, value, null);
        }

        protected Criterion(String condition, Object value, Object secondValue, String typeHandler) {
            super();
            this.condition = condition;
            this.value = value;
            this.secondValue = secondValue;
            this.typeHandler = typeHandler;
            this.betweenValue = true;
        }

        protected Criterion(String condition, Object value, Object secondValue) {
            this(condition, value, secondValue, null);
        }
    }
}

    整理后的XXXMapper.java文件
    public interface BaseMapper<T> {
    /**
     * 统计有多少条数据
     * @param example 条件
     * @return
     */
	int countByExample(Object example);
	
	/**
	 * 根据条件删除数据
	 * @param example
	 * @return
	 */
    int deleteByExample(Object example);
    
    /**
     *根据ID主键删除数据 
     * @param integer
     * @return
     */
    int deleteByPrimaryKey(Object integer);

    /***
     * 保存数据
     * @param record
     * @return
     */
    int insert(Object record);
    /**
     * 插入一条数据,只插入不为null的字段,不会影响有默认值的字段
     * @param record
     * @return
     */
    int insertSelective(Object record);
    
    /**
     * 查询列表
     * @param example
     * @return
     */
    List<T> selectByExample(Object example);

    /***
     * 根据主键查询对象
     * @param integer
     * @return
     */
    T selectByPrimaryKey(Object integer);

    /**
     * 根据条件修改对象(更新新的model中不为空的字段)
     * @param record
     * @param example
     * @return
     */
    int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);

    /**
     * 根据条件修改对象(会将model为空的字段在数据库中置为NULL)
     * @param record
     * @param example
     * @return
     */
    int updateByExample(@Param("record") T record, @Param("example") Object example);

    /**
     *根据主键修改对象 (更新新的model中不为空的字段)
     * @param record
     * @return
     */
    int updateByPrimaryKeySelective(T record);
    
    /**
     * 根据主键修改对象(会将model为空的字段在数据库中置为NULL)
     * @param record
     * @return
     */
    int updateByPrimaryKey(T record);
    
}
    整理后再生成的XXXMapper.java和XXXExample.java可以把里面的内容删除然后继承这两个就好了.

    实例下载地址http://download.csdn.net/download/zhong_ling/9878025  点击下载实例 

zhong_ling
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
通用Mapper Example类使用以及源码分析
西京刀客
06-11 6768
通用Mapper Example类源码分析 代码细节理解 1. criteria criteria 英 [kraɪ’tɪərɪə] 美 [kraɪ’tɪrɪə] n. 标准，条件（criterion的复数） 作者这里用 单词criteria 应该表达的是条件的意思，指sql where条件！ ...
java 声明静态类_java静态类声明--java类可以声明为static吗
weixin_35703300的博客
02-13 328
为了理解static关键字在类声明中的使用，首先我们需要了解类声明。有两种类，一种是top-level class；一种是inner class。Top-level classestop-level class可以被声明为包成员，每一个top-level类对应于一个文件名与类名相同的java文件。因为top-level class已经是top-level，所以没必要声明为static。如果把top...
mybatis利用generator自动生成的代码学习篇
Bush_nanjing的博客
03-23 1万+
XXXExample类的学习这个一般是用来帮助codeMan自定义查询用的类 里面有几个类 Criterion是最基本,最底层的Where条件，用于字段级的筛选，可以理解为每一个字段的where条件查询sql 片段public static class Criterion { private String condition;//where 后面的条件 private Object
mybatis中关于example类详解
热门推荐
luluyo的博客
08-15 7万+
这几天刚接触example，很多内容都是破碎的，写一篇博文加深理解。 一、什么是example类 mybatis-generator会为每个字段产生如上的Criterion，如果表的字段比较多,产生的Example类会十分庞大。理论上通过example类可以构造你想到的任何筛选条件。在mybatis-generator中加以配置，配置数据表的生成操作就可以自动生成example了。具...
mybatis 通用类example
genghongsheng的博客
06-28 750
使用mybatis插件generator可以为每个实体类生成一个example，可是若实体类过多，维护起来就不方便，笔者在此基础上改造了一下生成了一个公共的，代码如下： /** * Created by james.geng * Date: 2018\5\23 0023 */ public class Example { protected String orderByClause;...
mybatis generator 使用方法教程(生成带注释的实体类)
08-29
MyBatis Generator 使用方法教程（生成带注释的实体类） MyBatis Generator 是一个强大的工具，能够根据数据库表自动生成 Java 实体类、DAO、Mapper.xml 等文件，从而提高开发效率和减少开发时间。在本教程中，我们...
Mybatis Generator使用说明
最新发布
02-03
### Mybatis Generator使用说明 #### 一、简介 Mybatis Generator 是一款强大的代码生成工具，它可以根据数据库表结构自动生成相应的 Java 实体类、Mapper 接口、XML 映射文件等，极大地提高了开发效率，减少了...
Mybatis generator 使用
03-28
main = 'org.mybatis.generator.api.MyBatisGenerator' classpath configurations.mybatisGenerator args '-configfile', 'src/main/resources/generatorConfig.xml', '-overwrite' } ``` 接着运行 `gradle ...
IDEA中mybatis generator使用.docx
07-02
在【标题】"IDEA中mybatis generator使用.docx"中，主要涉及的是如何在项目中配置和使用MyBatis Generator。首先，我们需要在项目的`pom.xml`文件中添加MBG的插件依赖，这部分已经在【描述】中给出： ```xml ...
MyBatis Generator去掉生成的注解
09-01
默认情况下，MyBatis Generator使用的是`org.mybatis.generator.internal.DefaultCommentGenerator`。如果你想使用自定义的注释生成策略，你可以设置`type`属性，例如： ```xml ``` 这里，`...
idea使用generator插件自动生成代码工具遇到的问题
我是谁的博客
10-24 4622
idea使用generator插件问题
updateByPrimaryKey和updateByPrimaryKeySelective insert和insertSelective
红尘客栈_繁华的博客
04-19 1万+
这两个update都是使用generator生成的mapper.xml文件中,对dao层的更新操作 updateByPrimaryKey对你注入的字段全部更新（不判断是否为Null） updateByPrimaryKeySelective会对字段进行判断再更新(如果为Null就忽略更新) 区别了这两点就很容易根据业务来选择服务层的调用了！ 详细可以查看generator生成的源代码
Mybatis版PropertyFilter实现2
菜菜
07-07 221
import java.util.List; public class Criterion { private String condition; private Object value; private Object secondValue; private boolean noValue; private boolean single...
MyBatis学习总结（9）——使用MyBatis Generator自动创建代码
科技D人生
12-17 9303
由于MyBatis属于一种半自动的ORM框架，所以主要的工作就是配置Mapping映射文件，但是由于手写映射文件很容易出错，所以可利用MyBatis生成器自动生成实体类、DAO接口和Mapping映射文件。这样可以省去很多的功夫，将生成的代码copy到项目工程中即可。            使用自动生成有很多方式，可以在eclipse中安装插件，但是以下将要介绍的这种方式我认为很轻松，最简单
Mybatis生成器插件扩展，定制方法生成，list参数生成
茅坤宝骏氹的博客
12-19 705
Mybatis生成器插件扩展，定制方法生成 一、生成模式 （1）Example.Criterion添加pattern字段 public static class Criterion { private String condition; private Object value; private Object secondValue; private boolean noValue; private boole
java中static之对于class
Knowing something of everything and everything of something.
12-16 143
以下摘自于javaworld的一个问题的解答: 写道 Q:Can a class (whether an inner or outer class) be declared static?   A:In order to understand the use of the static keyword in class declaration, we need to understand th...
Springboot+MyBatis+JPA集成
weixin_30666401的博客
07-03 3712
1.前言 Springboot最近可谓是非常的火，本人也在项目中尝到了甜头。之前一直使用Springboot+JPA，用了一段时间发现JPA不是太灵活，也有可能是我不精通JPA，总之为了多学学Springboot我决定尝试一下Springboot+MyBatis+JPA三项集成，集成过程中遇到了很多问题，但最后总算是集成成功了，现在记录一下方法。 1.1 如何使用M...
Mybatis生成器插件扩展，生成findInSet方法
茅坤宝骏氹的博客
12-06 1318
Mybatis生成器插件扩展，生成findInSet方法 package com.mk.mybatisgenerator.plugins; import org.mybatis.generator.api.IntrospectedColumn; import org.mybatis.generator.api.IntrospectedTable; import org.mybatis.generator.api.PluginAdapter; import org.mybatis.generator..
一篇文章搞定Mybatis Generator（使用说明和原理讲解）
jiayoubing的专栏
05-05 2800
建立数据模型pdm，表结构前缀说明 cms_*：内容管理模块相关表 oms_*：订单管理模块相关表 pms_*：商品模块相关表 sms_*：营销模块相关表 ums_*：会员模块相关表 新建pom工程如下： 1.pom文件内容如下： <dependencies> <!-- https://mvnrepository.com/artifact/org...
MyBatis Generator 使用
05-20
使用 MyBatis Generator 可以大大减少开发人员的工作量，提高开发效率。 下面是使用 MyBatis Generator 的步骤： 1. 配置 generatorConfig.xml 文件，该文件用于配置生成代码的详细信息，包括数据库连接信息、生成...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值