`

Mybatis-Plus——为Mybatis镀一层金

阅读更多

    Mybatis-Plus是一个Mybatis的增强工具,它在Mybatis的基础上做了增强,却不做改变。我们在使用Mybatis-Plus之后既可以使用Mybatis-Plus的特有功能,又能够正常使用Mybatis的原生功能。Mybatis-Plus(以下简称MP)是为简化开发、提高开发效率而生,但它也提供了一些很有意思的插件,比如SQL性能监控、乐观锁、执行分析等。

    Mybatis虽然已经给我们提供了很大的方便,但它还是有不足之处,实际上没有什么东西是完美的,MP的存在就是为了稍稍弥补Mybatis的不足。在我们使用Mybatis时会发现,每当要写一个业务逻辑的时候都要在DAO层写一个方法,再对应一个SQL,即使是简单的条件查询、即使仅仅改变了一个条件都要在DAO层新增一个方法,针对这个问题,MP就提供了一个很好的解决方案,之后我会进行介绍。另外,MP的代码生成器也是一个很有意思的东西,它可以让我们避免许多重复性的工作,下面我将介绍如何在你的项目中集成MP。

集成步骤↓:(首先,你要有个spring项目)

  1. 集成依赖,pom中加入依赖即可,不多说:
    		<!-- mybatis mybatis-plus mybatis-spring mvc -->
    		<dependency>
    			<groupId>com.baomidou</groupId>
    			<artifactId>mybatis-plus</artifactId>
    			<version>${mybatis-plus.version}</version>
    		</dependency>
    		<dependency>
    			<groupId>org.apache.velocity</groupId>
    			<artifactId>velocity-engine-core</artifactId>
    			<version>2.0</version>
    		</dependency>
     说明:笔者使用的版本为:mybatis-plus.version=2.1-gamma,上边的代码中有两个依赖,第一个是mybatis-plus核心依赖,第二个是使用代码生成器时需要的模板引擎依赖,若果你不打算使用代码生成器,此处可不引入。

    注意:mybatis-plus的核心jar包中已集成了mybatis和mybatis-spring,所以为避免冲突,请勿再次引用这两个jar包。

  2. 在spring中配置MP:
    	<bean id="sqlSessionFactory"
    		class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean">
    		<!-- 配置数据源 -->
    		<property name="dataSource" ref="dataSource" />
    		<!-- 自动扫描 Xml 文件位置 -->
    		<property name="mapperLocations" value="classpath*:com/ds/orm/mapper/**/*.xml" />
    		<!-- 配置 Mybatis 配置文件(可无) -->
    		<property name="configLocation" value="classpath:mybatis-config.xml" />
    		<!-- 配置包别名,支持通配符 * 或者 ; 分割 -->
    		<property name="typeAliasesPackage" value="com.ds.orm.model" />
    		<!-- 枚举属性配置扫描,支持通配符 * 或者 ; 分割 -->
    		<!-- <property name="typeEnumsPackage" value="com.baomidou.springmvc.entity.*.enums" 
    			/> -->
    		<!-- 以上配置和传统 Mybatis 一致 -->
    
    		<!-- MP 全局配置注入 -->
    		<property name="globalConfig" ref="globalConfig" />
    	</bean>
    
    	<!-- 定义 MP 全局策略 -->
    	<bean id="globalConfig" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
    		<!-- 主键策略配置 -->
    		<!-- 可选参数 AUTO->`0`("数据库ID自增") INPUT->`1`(用户输入ID") ID_WORKER->`2`("全局唯一ID") 
    			UUID->`3`("全局唯一ID") -->
    		<property name="idType" value="2" />
    		<!-- 数据库类型配置 -->
    		<!-- 可选参数(默认mysql) MYSQL->`mysql` ORACLE->`oracle` DB2->`db2` H2->`h2` 
    			HSQL->`hsql` SQLITE->`sqlite` POSTGRE->`postgresql` SQLSERVER2005->`sqlserver2005` 
    			SQLSERVER->`sqlserver` -->
    		<property name="dbType" value="mysql" />
    		<!-- 全局表为下划线命名设置 true -->
    		<property name="dbColumnUnderline" value="true" />
    		<property name="sqlInjector">
    			<bean class="com.baomidou.mybatisplus.mapper.AutoSqlInjector" />
    		</property>
    	</bean>
    	<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    		<description>DAO接口所在包名,Spring会自动查找其下的类</description>
    		<property name="basePackage" value="com.ds.orm.mapper" />
    		<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
    	</bean>
    	<!-- 乐观锁插件 -->
    	<bean class="com.baomidou.mybatisplus.plugins.OptimisticLockerInterceptor" />
    
    	<!-- xml mapper热加载 sqlSessionFactory:session工厂 mapperLocations:mapper匹配路径 
    		enabled:是否开启动态加载 默认:false delaySeconds:项目启动延迟加载时间 单位:秒 默认:10s sleepSeconds:刷新时间间隔 
    		单位:秒 默认:20s -->
    	<bean class="com.baomidou.mybatisplus.spring.MybatisMapperRefresh">
    		<constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory" />
    		<constructor-arg name="mapperLocations"
    			value="classpath*:com/ds/orm/mapper/*/*.xml" />
    		<constructor-arg name="delaySeconds" value="10" />
    		<constructor-arg name="sleepSeconds" value="20" />
    		<constructor-arg name="enabled" value="true" />
    	</bean>
    
    	<!-- 事务 -->
    	<bean id="transactionManager"
    		class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    		<property name="dataSource" ref="dataSource" />
    	</bean>
    	<tx:annotation-driven transaction-manager="transactionManager"
    		proxy-target-class="true" />
     注意:只要做如上配置就可以正常使用mybatis了,不要重复配置。MP的配置和mybatis一样,都是配置一个sqlSessionFactory,只是现在所配置的类在原本的SqlSessionFactoryBean基础上做了增强。插件等配置请按需取舍。
  3. 插件配置,按需求配置就可以,此处把可以配置的插件都列了出来,具体的请看代码注释:
    <configuration>
    	<settings>
    		<setting name="logImpl" value="SLF4J" />
    		<!-- 字段为空时仍调用model的set方法或map的put方法 -->
    		<setting name="callSettersOnNulls" value="true" />
    	</settings>
    	<plugins>
    		<!-- | 分页插件配置 | 插件提供二种方言选择:1、默认方言 2、自定义方言实现类,两者均未配置则抛出异常! | overflowCurrent 
    			溢出总页数,设置第一页 默认false | optimizeType Count优化方式 ( 版本 2.0.9 改为使用 jsqlparser 不需要配置 
    			) | -->
    		<!-- 注意!! 如果要支持二级缓存分页使用类 CachePaginationInterceptor 默认、建议如下!! -->
    		<plugin interceptor="com.baomidou.mybatisplus.plugins.PaginationInterceptor">
    			<property name="dialectType" value="mysql" />
    			<!--<property name="sqlParser" ref="自定义解析类、可以没有" />
    			<property name="localPage" value="默认 false 改为 true 开启了 pageHeper 支持、可以没有" />
    			<property name="dialectClazz" value="自定义方言类、可以没有" /> -->
    		</plugin>
    
    		<!-- SQL 执行性能分析,开发环境使用,线上不推荐。 maxTime 指的是 sql 最大执行时长 -->
    		<plugin interceptor="com.baomidou.mybatisplus.plugins.PerformanceInterceptor">
    			<property name="maxTime" value="2000" />
    			<!--SQL是否格式化 默认false -->
    			<property name="format" value="true" />
    		</plugin>
    
    		<!-- SQL 执行分析拦截器 stopProceed 发现全表执行 delete update 是否停止运行 该插件只用于开发环境,不建议生产环境使用。。。 -->
    		<plugin interceptor="com.baomidou.mybatisplus.plugins.SqlExplainInterceptor">
    			<property name="stopProceed" value="false" />
    		</plugin>
    	</plugins>
    </configuration>
     注意:执行分析拦截器和性能分析推荐只在开发时调试程序使用,为保证程序性能和稳定性,建议在生产环境中注释掉这两个插件。
  4. 数据源:(此处使用druid)
    	<!-- 配置数据源 -->
    	<bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
    		<!--		<property name="driverClassName" value="${jdbc.driverClassName}" /> -->
    		<property name="url" value="${jdbc.url}" /> 
    		<property name="username" value="${jdbc.username}" /> 
    		<property name="password" value="${jdbc.password}" /> 
    		<property name="initialSize" value="${jdbc.initialSize}" /> 
    		<property name="minIdle" value="${jdbc.minIdle}" /> 
    		<property name="maxActive" value="${jdbc.maxActive}" /> 
    		<property name="maxWait" value="${jdbc.maxWait}" /> 
    		<property name="timeBetweenEvictionRunsMillis" value="${jdbc.timeBetweenEvictionRunsMillis}" /> 
    		<property name="minEvictableIdleTimeMillis" value="${jdbc.minEvictableIdleTimeMillis}" /> 
    		<property name="validationQuery" value="${jdbc.validationQuery}" /> 
    		<property name="testWhileIdle" value="${jdbc.testWhileIdle}" /> 
    		<property name="testOnBorrow" value="${jdbc.testOnBorrow}" /> 
    		<property name="testOnReturn" value="${jdbc.testOnReturn}" /> 
    		<property name="removeAbandoned" value="${jdbc.removeAbandoned}" /> 
    		<property name="removeAbandonedTimeout" value="${jdbc.removeAbandonedTimeout}" /> 
    		<!--	    <property name="logAbandoned" value="${jdbc.logAbandoned}" /> -->
    		<property name="filters" value="${jdbc.filters}" />
    		<!-- 关闭abanded连接时输出错误日志 -->
    		<property name="logAbandoned" value="true" />
    		<property name="proxyFilters">
    			<list>
    				<ref bean="log-filter"/>
    			</list>
    		</property>
    
    		<!-- 监控数据库 -->
    		<!-- <property name="filters" value="stat" /> -->
    		<!--		<property name="filters" value="mergeStat" />-->
    	</bean>

到此,MP已经集成进我们的项目中了,下面将介绍它是如何简化我们的开发的。

 

简单的CURD操作↓:
假设我们有一张user表,且已经建立好了一个与此表对应的实体类User,我们来介绍对user的简单增删改查操作。
  1. 建立DAO层接口。我们在使用普通的mybatis时会建立一个DAO层接口,并对应一个xml用来写SQL。在这里我们同样要建立一个DAO层接口,但是若无必要,我们甚至不需要建立xml,就可以进行资源的CURD操作了,我们只需要让我们建立的DAO继承MP提供的BaseMapper<?>即可:
    public interface UserMapper extends BaseMapper<User> { }
     然后在我们需要做数据CURD时,像下边这样就好了:
    // 初始化 影响行数
    int result = 0;
    // 初始化 User 对象
    User user = new User();
    
    // 插入 User (插入成功会自动回写主键到实体类)
    user.setName("Tom");
    result = userMapper.insert(user);
    
    // 更新 User
    user.setAge(18);
    result = userMapper.updateById(user);//user要设置id哦,具体的在下边我会详细介绍
    
    // 查询 User
    User exampleUser = userMapper.selectById(user.getId());
    
    // 查询姓名为‘张三’的所有用户记录
    List<User> userList = userMapper.selectList(
            new EntityWrapper<User>().eq("name", "张三")
    );
    
    // 删除 User
    result = userMapper.deleteById(user.getId());
     方便吧?如果只使用mybatis可是要写4个SQL和4个方法喔,当然了,仅仅上边这几个方法还远远满足不了我们的需求,请往下看:
  2. 多条件分页查询:
    // 分页查询 10 条姓名为‘张三’、性别为男,且年龄在18至50之间的用户记录
    List<User> userList = userMapper.selectPage(
            new Page<User>(1, 10),
            new EntityWrapper<User>().eq("name", "张三")
                    .eq("sex", 0)
                    .between("age", "18", "50")
    );
    
    /**等价于SELECT *
    *FROM sys_user
    *WHERE (name='张三' AND sex=0 AND age BETWEEN '18' AND '50')
    *LIMIT 0,10
    */
     下边这个,多条件构造器。其实对于条件过于复杂的查询,笔者还是建议使用原生mybatis的方式实现,易于维护且逻辑清晰,如果所有的数据操作都强行使用MP,就失去了MP简化开发的意义了。所以在使用时请按实际情况取舍,在这里还是先介绍一下。
    public Page<T> selectPage(Page<T> page, EntityWrapper<T> entityWrapper) {
      if (null != entityWrapper) {
          entityWrapper.orderBy(page.getOrderByField(), page.isAsc());//排序
      }
      page.setRecords(baseMapper.selectPage(page, entityWrapper));//将查询结果放入page中
      return page;
    }
     条件构造一(上边方法的entityWrapper参数):
    public void testTSQL11() {
        /*
         * 实体带查询使用方法  输出看结果
         */
        EntityWrapper<User> ew = new EntityWrapper<User>();
        ew.setEntity(new User(1));
        ew.where("user_name={0}", "'zhangsan'").and("id=1")
                .orNew("user_status={0}", "0").or("status=1")
                .notLike("user_nickname", "notvalue")
                .andNew("new=xx").like("hhh", "ddd")
                .andNew("pwd=11").isNotNull("n1,n2").isNull("n3")
                .groupBy("x1").groupBy("x2,x3")
                .having("x1=11").having("x3=433")
                .orderBy("dd").orderBy("d1,d2");
        System.out.println(ew.getSqlSegment());
    }
      条件构造二(同上):
    int buyCount = selectCount(Condition.create()
                    .setSqlSelect("sum(quantity)")
                    .isNull("order_id")
                    .eq("user_id", 1)
                    .eq("type", 1)
                    .in("status", new Integer[]{0, 1})
                    .eq("product_id", 1)
                    .between("created_time", startDate, currentDate)
                    .eq("weal", 1));
     自定义条件使用entityWrapper:
    List<User> selectMyPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);
     
    <select id="selectMyPage" resultType="User">
      SELECT * FROM user 
      <where>
      ${ew.sqlSegment}
      </where>
    </select>
     注意:此处不用担心SQL注入,MP已对ew做了字符串转义处理。

其实在使用MP做数据CURD时,还有另外一个方法,AR(ActiveRecord ),很简单,让我们的实体类继承MP提供Model<?>就好了,这和我们常用的方法可能会有些不同,下边简单说一下吧:

//实体类
@TableName("sys_user") // 注解指定表名
public class User extends Model<User> {

  ... // fields

  ... // getter and setter

  /** 指定主键 */
  @Override
  protected Serializable pkVal() {  //一定要指定主键哦
      return this.id;
  }
}
 下边就是CURD操作了:
// 初始化 成功标识
boolean result = false;
// 初始化 User
User user = new User();

// 保存 User
user.setName("Tom");
result = user.insert();

// 更新 User
user.setAge(18);
result = user.updateById();

// 查询 User
User exampleUser = t1.selectById();

// 查询姓名为‘张三’的所有用户记录
List<User> userList1 = user.selectList(
        new EntityWrapper<User>().eq("name", "张三")
);

// 删除 User
result = t2.deleteById();
 
// 分页查询 10 条姓名为‘张三’、性别为男,且年龄在18至50之间的用户记录
List<User> userList = user.selectPage(
        new Page<User>(1, 10),
        new EntityWrapper<User>().eq("name", "张三")
                .eq("sex", 0)
                .between("age", "18", "50")
).getRecords();
 就是这样了,可能你会说MP封装的有些过分了,这样做会分散数据逻辑到不同的层面中,难以管理,使代码难以理解。其实确实是这样,这就需要你在使用的时候注意一下了,在简化开发的同时也要保证你的代码层次清晰,做一个战略上的设计或者做一个取舍与平衡。

 

其实上边介绍的功能也不是MP的全部啦,下边介绍一下MP最有意思的模块——代码生成器。
步骤↓:
  1. 如上边所说,使用代码生成器一定要引入velocity-engine-core(模板引擎)这个依赖。
  2. 准备工作:
  • 选择主键策略,就是在上边最开始时候我介绍MP配置时其中的这项配置,如果你不记得了,请上翻!MP提供了如下几个主键策略: 值 描述
    IdType.AUTO 数据库ID自增
    IdType.INPUT 用户输入ID
    IdType.ID_WORKER 全局唯一ID,内容为空自动填充(默认配置)
    IdType.UUID 全局唯一ID,内容为空自动填充

    MP默认使用的是ID_WORKER,这是MP在Sequence的基础上进行部分优化,用于产生全局唯一ID。

  • 表及字段命名策略选择,同上,还是在那个配置中。下边这段复制至MP官方文档:

    在MP中,我们建议数据库表名采用下划线命名方式,而表字段名采用驼峰命名方式

    这么做的原因是为了避免在对应实体类时产生的性能损耗,这样字段不用做映射就能直接和实体类对应。当然如果项目里不用考虑这点性能损耗,那么你采用下滑线也是没问题的,只需要在生成代码时配置dbColumnUnderline属性就可以。

  • 建表(命名规则依照刚才你所配置的,这会影响生成的代码的类名、字段名是否正确)。
  • 执行下边的main方法,生成代码:
    import java.util.HashMap;
    import java.util.Map;
    
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.InjectionConfig;
    import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
    import com.baomidou.mybatisplus.generator.config.GlobalConfig;
    import com.baomidou.mybatisplus.generator.config.PackageConfig;
    import com.baomidou.mybatisplus.generator.config.StrategyConfig;
    import com.baomidou.mybatisplus.generator.config.rules.DbType;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    
    /**
     * <p>
     * 代码生成器演示
     * </p>
     */
    public class MpGenerator {
    
        /**
         * <p>
         * MySQL 生成演示
         * </p>
         */
        public static void main(String[] args) {
            AutoGenerator mpg = new AutoGenerator();
    
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            gc.setOutputDir("D://");
            gc.setFileOverride(true);
            gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false
            gc.setEnableCache(false);// XML 二级缓存
            gc.setBaseResultMap(true);// XML ResultMap
            gc.setBaseColumnList(false);// XML columList
        // .setKotlin(true) 是否生成 kotlin 代码
            gc.setAuthor("Yanghu");
    
            // 自定义文件命名,注意 %s 会自动填充表实体属性!
            // gc.setMapperName("%sDao");
            // gc.setXmlName("%sDao");
            // gc.setServiceName("MP%sService");
            // gc.setServiceImplName("%sServiceDiy");
            // gc.setControllerName("%sAction");
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setDbType(DbType.MYSQL);
            dsc.setTypeConvert(new MySqlTypeConvert(){
                // 自定义数据库表字段类型转换【可选】
                @Override
                public DbColumnType processTypeConvert(String fieldType) {
                    System.out.println("转换类型:" + fieldType);
            // 注意!!processTypeConvert 存在默认类型转换,如果不是你要的效果请自定义返回、非如下直接返回。
                    return super.processTypeConvert(fieldType);
                }
            });
            dsc.setDriverName("com.mysql.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("521");
            dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mybatis-plus?characterEncoding=utf8");
            mpg.setDataSource(dsc);
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
        // strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
            strategy.setTablePrefix(new String[] { "tlog_", "tsys_" });// 此处可以修改为您的表前缀
            strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
            // strategy.setInclude(new String[] { "user" }); // 需要生成的表
            // strategy.setExclude(new String[]{"test"}); // 排除生成的表
            // 自定义实体父类
            // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
            // 自定义实体,公共字段
            // strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
            // 自定义 mapper 父类
            // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
            // 自定义 service 父类
            // strategy.setSuperServiceClass("com.baomidou.demo.TestService");
            // 自定义 service 实现类父类
            // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
            // 自定义 controller 父类
            // strategy.setSuperControllerClass("com.baomidou.demo.TestController");
            // 【实体】是否生成字段常量(默认 false)
            // public static final String ID = "test_id";
            // strategy.setEntityColumnConstant(true);
            // 【实体】是否为构建者模型(默认 false)
            // public User setName(String name) {this.name = name; return this;}
            // strategy.setEntityBuilderModel(true);
            mpg.setStrategy(strategy);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setParent("com.baomidou");
            pc.setModuleName("test");
            mpg.setPackageInfo(pc);
    
            // 注入自定义配置,可以在 VM 中使用 cfg.abc 【可无】
            InjectionConfig cfg = new InjectionConfig() {
                @Override
                public void initMap() {
                    Map<String, Object> map = new HashMap<String, Object>();
                    map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
                    this.setMap(map);
                }
            };
    
            // 自定义 xxList.jsp 生成
            List<FileOutConfig> focList = new ArrayList<FileOutConfig>();
            focList.add(new FileOutConfig("/template/list.jsp.vm") {
                @Override
                public String outputFile(TableInfo tableInfo) {
                    // 自定义输入文件名称
                    return "D://my_" + tableInfo.getEntityName() + ".jsp";
                }
            });
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
    
        // 调整 xml 生成目录演示
             focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
                @Override
                public String outputFile(TableInfo tableInfo) {
                    return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";
                }
            });
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
    
            // 关闭默认 xml 生成,调整生成 至 根目录
            TemplateConfig tc = new TemplateConfig();
            tc.setXml(null);
            mpg.setTemplate(tc);
    
            // 自定义模板配置,可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改,
            // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置,也可以自定义模板名称
            // TemplateConfig tc = new TemplateConfig();
            // tc.setController("...");
            // tc.setEntity("...");
            // tc.setMapper("...");
            // tc.setXml("...");
            // tc.setService("...");
            // tc.setServiceImpl("...");
        // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。
            // mpg.setTemplate(tc);
    
            // 执行生成
            mpg.execute();
    
            // 打印注入设置【可无】
            System.err.println(mpg.getCfg().getMap().get("abc"));
        }
    
    }
     说明:中间的内容请自行修改,注释很清晰。

成功生成代码,将生成的代码拷贝到你的项目中就可以了,这个东西节省了我们大量的时间和精力!

 

下边我将介绍MP提供的很有意思的插件:

  1. 分页插件:插件的配置请看上边开篇时的MP配置部分。
    public interface UserMapper{//可以继承或者不继承BaseMapper
        /**
         * <p>
         * 查询 : 根据state状态查询用户列表,分页显示
         * </p>
         *
         * @param page
         *            翻页对象,可以作为 xml 参数直接使用,传递参数 Page 即自动分页
         * @param state
         *            状态
         * @return
         */
        List<User> selectUserList(Pagination page, Integer state);
    }
     
    public Page<User> selectUserPage(Page<User> page, Integer state) {
        page.setRecords(userMapper.selectUserList(page, state));
        return page;
    }
     
    <select id="selectUserList" resultType="User">
        SELECT * FROM user WHERE state=#{state}
    </select>
     
  2. 乐观锁插件:当要更新一条记录的时候,希望这条记录没有被别人更新过。

    其实原理很简单:

    • 取出记录时,获取当前version
    • 更新时,带上这个version
    • 执行更新时, set version = yourVersion+1 where version = yourVersion
    • 如果version不对,就更新失败

     插件的配置请看上边开篇时的MP配置部分,使用该插件的表必须拥有能够作为version的字段,比如update_date:

    public class User {
    
        @Version
        private Integer version;
    
        ...
    }

     说明:version仅支持int,Integer,long,Long,Date,Timestamp类型。

    int id = 100;
    int version = 2;
    
    User u = new User();
    u.setId(id);
    u.setVersion(version);
    u.setXXX(xxx);
    
    if(userService.updateById(u)){
        System.out.println("Update successfully");
    }else{
        System.out.println("Update failed due to modified by others");
    }
    //等价于:update tbl_user set name='update',version=3 where id=100 and version=2;
    
  3. 执行分析插件,作用是分析处理 DELETE UPDATE 语句, 防止小白或者恶意 delete update 全表操作,不推荐生产环境使用。具体配置请看上边开篇时的MP配置部分。
  4. 性能分析插件,用于输出每条 SQL 语句及其执行时间,不推荐生产环境使用。具体配置请看上边开篇时的MP配置部分。
  5. xml热加载插件,具体配置请看上边开篇时的MP配置部分。

好了,插件介绍到这,以下是注解说明,摘自官方文档:

注解说明

表名注解 @TableName

  • com.baomidou.mybatisplus.annotations.TableName
值 描述
value 表名( 默认空 )
resultMap xml 字段映射 resultMap ID

主键注解 @TableId

  • com.baomidou.mybatisplus.annotations.TableId
值 描述
value 字段值(驼峰命名方式,该值可无)
type 主键 ID 策略类型( 默认 INPUT ,全局开启的是 ID_WORKER )

暂不支持组合主键

字段注解 @TableField

  • com.baomidou.mybatisplus.annotations.TableField
值 描述
value 字段值(驼峰命名方式,该值可无)
el 详看注释说明
exist 是否为数据库表字段( 默认 true 存在,false 不存在 )
strategy 字段验证 ( 默认 非 null 判断,查看 com.baomidou.mybatisplus.enums.FieldStrategy )
fill 字段填充标记 ( FieldFill, 配合自动填充使用 )
  • 字段填充策略 FieldFill
值 描述
DEFAULT 默认不处理
INSERT 插入填充字段
UPDATE 更新填充字段
INSERT_UPDATE 插入和更新填充字段

序列主键策略 注解 @KeySequence

  • com.baomidou.mybatisplus.annotations.KeySequence
值 描述
value 序列名
clazz id的类型

乐观锁标记注解 @Version

  • com.baomidou.mybatisplus.annotations.Version

排除非表字段、查看文档常见问题部分!

 

 

     总结:MP的宗旨是简化开发,但是它在提供方便的同时却容易造成代码层次混乱,我们可能会把大量数据逻辑写到service层甚至contoller层中,使代码难以阅读。凡事过犹不及,在使用MP时一定要做分析,不要将所有数据操作都交给MP去实现。毕竟MP只是mybatis的增强工具,它并没有侵入mybatis的原生功能,在使用MP的增强功能的同时,原生mybatis的功能依然是可以正常使用的。

 

1
0
分享到:
评论
1 楼 岛田无涯 2018-04-14  
写的很详细  感谢

相关推荐

    mybatis-plus代码生成器的两种方式.zip

    本文将深入探讨两种Mybatis-Plus中的代码生成器——MysqlGenerator与CodeGenerator,帮助开发者提高开发效率,减少手动编写重复性代码的时间。 首先,我们来看MysqlGenerator。如其名,这是一个针对MySQL数据库的...

    mybatis-plus反向工程 自动生成3层架构的文件controller,service,dao,mapper.zip

    - "mybatis-plus代码生成器 - 唯学习方能解忧 - CSDN博客.url"、"1.Mybatis Plus————代码生成器 - 燃烧的小宇宙 - CSDN博客.url":这两个链接指向CSDN上的博客文章,可能提供了更详细的MyBatis-Plus代码生成器...

    springboot-mabatisplus-demo.rar

    一、SpringBoot与Mybatis-Plus的集成 1. 添加依赖:在`pom.xml`文件中引入SpringBoot的starter-web和mybatis-plus-boot-starter依赖,确保项目可以运行并支持Mybatis-Plus。 ```xml &lt;groupId&gt;org.springframework...

    复习资料汇总:包括mybatis-plus spingboot等

    这份复习资料汇总涵盖了两个重要的Java开发框架——MyBatis-Plus和SpringBoot。这两个框架在现代Java Web开发中扮演着核心角色,极大地提升了开发效率和项目的可维护性。 1. MyBatis-Plus(MBP): MyBatis-Plus是...

    SSM基础框架(整合Spring、Spring MVC 、MyBatis-plus)(全注解版)

    SSM基础框架是Java开发中常用的三大组件——Spring、Spring MVC和MyBatis的集成,它们共同构建了一个高效、灵活的后端应用架构。在这个全注解版本中,我们将探讨如何利用注解来简化配置,实现快速开发。 首先,...

    springboot+security+mybatis-plus实现自定义认证用户数据源的接口开发

    MyBatis-Plus则是一个MyBatis的扩展库,它简化了数据访问层的开发,提供了丰富的CRUD操作。在本项目中,MyBatis-Plus可能被用来操作用户数据表,例如获取用户信息、检查用户密码等。通过定义Mapper接口和Mapper XML...

    个人毕业设计 电脑售后管理系统 Springboot+Mybatis-plus+Vue前后端分离.zip

    《电脑售后管理系统——基于Springboot+Mybatis-plus+Vue的前后端分离实现》 本项目是一个个人毕业设计,旨在构建一个电脑售后管理系统,利用现代化的技术栈实现前后端分离,为用户提供便捷、高效的售后服务管理...

    maven+springmvc+mybatis+log4j框架搭建

    本教程将详细阐述如何使用四个关键组件——Maven、SpringMVC、MyBatis和Log4j——来搭建一个强大的Web应用框架,旨在提高开发效率并优化项目管理。 **Maven** 是一个流行的项目管理和综合工具,它通过统一的构建...

    bookkeeping:周先生SpringBoot + Mybatis-plus + Vue整合小案例

    在这个“bookkeeping:周先生SpringBoot + Mybatis-plus + Vue整合小案例”中,我们可以学习到如何将三种流行的技术——SpringBoot、Mybatis-plus和Vue.js整合在一起,创建一个简单的会计记账应用。这个项目主要涵盖...

    free-idea-mybatis-2019.11.16.zip

    今天我们将探讨的是一款专为IDEA定制的Mybatis插件——"Free Mybatis Plugins",其2019.11.16版本为开发者带来了诸多便利。 Mybatis,一个轻量级的Java持久层框架,以其简单易用和灵活高效的特点,深受广大开发者的...

    ssm(spring+springmvc+mybatis)整合需要的jar包

    SSM框架是Java Web开发中常用的三大框架——Spring、SpringMVC和MyBatis的集成,它们协同工作,提供了一套高效、灵活的后端开发解决方案。以下将详细阐述这三大框架及其整合过程中的关键知识点。 1. Spring框架:...

    SSM框架(IDEA+Spring+SpringMVC+Maven+Mybatis)

    SSM框架是Java开发中广泛使用的三大开源框架——Spring、SpringMVC和Mybatis的集成,它们协同工作,为Web应用程序提供了一套高效且灵活的解决方案。本项目使用IntelliJ IDEA作为集成开发环境(IDE),同时结合Maven...

    mybatis分页插件代码

    【标题】"mybatis分页插件代码"主要涉及到MyBatis框架中的一种增强功能——分页插件的使用。MyBatis是一个优秀的持久层框架,它支持定制化SQL、存储过程以及高级映射。在处理大数据量时,分页查询是必不可少的优化...

    学生管理系统简单增删改查

    3. **编写Mapper接口**:创建一个StudentMapper接口,继承MyBatis-Plus提供的BaseMapper接口,无需手动编写SQL,只需定义基本的CRUD方法,MyBatis-Plus会自动生成对应的SQL语句。 4. **Service层实现**:创建...

    FastCoding.zip

    Mybatis-Plus是一个Mybatis的增强工具,它在Mybatis的基础上做了很多自动化处理,如自动填充公共字段、一键生成CRUD操作等。Mybatis-Plus的使用简化了SQL编写,减少了开发中的工作量,同时也提高了代码的可维护性。 ...

    MyBatis框架的学习(六)——MyBatis整合Spring

    在Java开发领域,MyBatis和Spring是两个非常重要的框架,它们各自在持久层和应用层管理方面发挥着重要作用。本篇文章将详细讲解如何将MyBatis与Spring进行整合,以便于实现更高效、更灵活的数据库操作和事务管理。 ...

    hf-develop-basis:个人学习

    【标题】"hf-develop-basis:个人学习"涵盖了两个主要的Java开发框架——MyBatis-Plus和MyBatis-TK的基础使用方法。这是一份针对个人学习的资源包,旨在帮助开发者熟悉这两个流行的持久层工具。 【描述】中提到的...

    SSM框架(IDEA+Spring+SpringMVC+Maven+Mybatis+MySQL)

    SSM框架是Java Web开发中常用的三大框架——Spring、SpringMVC和Mybatis的集成,它们结合了各自的优势,提供了一种高效、灵活且可扩展的开发解决方案。在这个项目中,我们还将涉及到IDEA(IntelliJ IDEA)作为开发...

    springMVC整合MyBatis——SSM

    MyBatis是一个轻量级的持久层框架,它将SQL与Java代码分离,通过XML或注解方式配置和映射原生信息,将接口和Java的POJOs(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录。MyBatis消除了几乎所有的...

    深入浅出MyBatis技术原理与实战

    《深入浅出MyBatis技术原理与实战》一书,旨在为Java开发人员提供一份全面且深入的MyBatis框架实战教程。MyBatis作为一款轻量级的Java持久层框架,深受广大开发者喜爱,其核心特性在于将SQL语句与Java代码紧密集成,...

Global site tag (gtag.js) - Google Analytics