mybatis-plus公共字段自动填充

小咪咪 2024-04-19 00:35 155阅读 0赞

github地址[https://github.com/heng1234/mybatis\_plus][https_github.com_heng1234_mybatis_plus]

需求: 要求insert或者update填充当前时间

主要是工具类和实体字段属性加入注解

**@TableField(fill = FieldFill.UPDATE)//修改时填充 **

**@TableField(fill = FieldFill.INSERT)//插入时填充**

代码

实体:

package com.hlvy.mybatis_plus.entity;
    
    import com.baomidou.mybatisplus.annotation.*;
    import com.baomidou.mybatisplus.extension.activerecord.Model;
    import lombok.Data;
    import lombok.EqualsAndHashCode;
    
    import java.util.Date;
    
    /**
     * User
     *
     * @author heng
     * @date 2019/4/11
     **/
    @Data
    /**@auth
     * @TableName 指定数据库表名
     * extends Model<User> AR模式
     * @EqualsAndHashCode(callSuper = false) 去除AR模式继承没调用父类方法警告警告
     */
    @TableName("User")
    @EqualsAndHashCode(callSuper = false)
    public class User  extends Model<User> {
    
        /**
         * @TableId 指定主键列名及主键策略方式
         */
        @TableId(value = "id",type = IdType.NONE)
        private Long id;
        /**
         * 姓名
         *@TableField 指定数据库列名
         */
        @TableField(condition = SqlCondition.LIKE,value = "name")
        private String name;
    
        /**
         * 年龄
         */
        @TableField(condition = "%s<#{%s}")
        private Integer age;
    
        /**
         * 邮箱
         */
        @TableField("email")
        private String email;
        /**
         * 直属上级id
         */
        private Long managerId;
        /**
         * 创建时间
         */
        @TableField(fill = FieldFill.INSERT)//插入时填充
        private Date createdTime;
    
        /**
         * 修改时间
         */
        @TableField(fill = FieldFill.UPDATE)//修改时填充
        private Date updateTime;
    
        /**
         * 版本
         */
        private Integer version;
        /**
         * 0、未删除 1、已删除
         */
        @TableLogic//逻辑删除标识
        @TableField(select = false)//查询的时候不显示
        private Integer deleted;
    
    
        /** 备注  非数据库字段需要排除
         * 方法一加入transient 不让该变量序列化 不推荐
         *  方法二加入static 但是lombok不会生成get set方法需要自己手动添加 不推荐
         *  方法三  @TableField(exist = false) 默认是true 改为false表示不是数据库字段 推荐
         * */
        @TableField(exist = false)
        private /*static*/  /*transient*/ String remark;
    }

工具类:

package com.hlvy.mybatis_plus.comporent;
    
    import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
    import org.apache.ibatis.reflection.MetaObject;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    import java.time.LocalDateTime;
    import java.util.Date;
    
    /**
     * MetaObjectHandler
     * 自动填充工具类
     * @author heng
     * @date 2019/9/14
     **/
    @Component
    public class MyMetaObjectHandler implements MetaObjectHandler {
    private static final Logger LOGGER= LoggerFactory.getLogger(MyMetaObjectHandler.class);
    
        @Override
        public void insertFill(MetaObject metaObject) {
            //是否存在set方法
          boolean bol =   metaObject.hasSetter("createdTime");
          //拿到createdTime的值
            Object createdTime = getFieldValByName("createdTime", metaObject);
            //插入时填充创建时间 fieldName是属性名
            LOGGER.info("insert 自动填充 "+ LocalDateTime.now());
           // setInsertFieldValByName("createTime", LocalDateTime.now(),metaObject);
            if(bol){//有set方法
            if (createdTime == null) {//值为null填充
                setFieldValByName("createdTime", new Date(), metaObject);
             }
            }
        }
    
        @Override
        public void updateFill(MetaObject metaObject) {
            //是否存在set方法
            boolean bol =   metaObject.hasSetter("updateTime");
            //拿到updateTime的值
            Object updateTime = getFieldValByName("updateTime", metaObject);
            //修改时填充当前时间  fieldName是属性名
            LOGGER.info("update 自动填充 "+ LocalDateTime.now());
            //setUpdateFieldValByName("updateTime", LocalDateTime.now(),metaObject);
           if (bol){//有set方法
            if (updateTime == null) {//值为null填充
                setFieldValByName("updateTime", new Date(), metaObject);
            }
           }
        }
    }

测试类

package com.hlvy.mybatis_plus.userTest;
    
    import com.baomidou.mybatisplus.core.toolkit.Wrappers;
    import com.hlvy.mybatis_plus.entity.User;
    import com.hlvy.mybatis_plus.mapper.UserMapper;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.util.List;
    
    /**
     * UserTestNew
     * mp进阶 自动填充
     * @author heng
     * @date 2019/4/11
     **/
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class FillUserTestNew {
    
        @Autowired
        private UserMapper userMapper;
        /**
         * 插入一行user      自动填充
         * sql INSERT INTO User ( id, name, age, email, created_time ) VALUES ( 1172866953920393218, '恒果果', 19, 'xxx@qq.com', '2019-09-14 13:37:27.29' )
         */
        @Test
        public void insertUser() {
            System.out.println(("----- insertUser method test ------"));
            User user = new User();
            user.setName("恒果果");
            user.setAge(19);
            user.setEmail("xxx@qq.com");
            int row = userMapper.insert(user);
            System.out.println("插入成功"+row+"行");
        }
    
        /**
         * 修改 自动填充
         * 执行sql UPDATE User SET age=17, update_time='2019-09-14 13:26:30.305' WHERE id=5 AND deleted=0
         */
        @Test
        public void updateOne() {
          User user = new User();
          user.setId(5L);
          user.setAge(17);
          System.out.println(userMapper.updateById(user));
        }
    
    
    
    
    }

pom文件

<?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>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.4.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.hlvy</groupId>
        <artifactId>mybatis_plus</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>mybatis_plus</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            
           
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
    
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.1.2</version>
            </dependency>
    
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.1.2</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.28</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

application.yml 文件

server:
      port: 9091
    spring:
      datasource:
        url: jdbc:mysql://127.0.0.1:3306/mytest?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=GMT
        username: root
        password: 123456
        driver-class-name: com.mysql.cj.jdbc.Driver
    mybatis-plus:
      #MyBaits 别名包扫描路径，通过该属性可以给包中的类注册别名，注册后在 Mapper 对应的 XML 文件中可以直接使用类名，而不用使用全限定的类名（即 XML 中调用的时候不用包含包名）。
      type-aliases-package: com.hlvy.mybatis_plus.entity
      #该配置请和 typeAliasesPackage 一起使用，如果配置了该属性，则仅仅会扫描路径下以该类作为父类的域对象
      type-aliases-super-type: java.lang.Object
      #MyBatis Mapper 所对应的 XML 文件位置，如果您在 Mapper 中有自定义方法（XML 中有自定义实现），需要进行该配置，告诉 Mapper 所对应的 XML 文件位置。
      mapper-locations: classpath*:mybatis/*.xml
      #MyBatis 配置文件位置，如果您有单独的 MyBatis 配置，请将其路径配置到 configLocation 中。
      #config-location: classpath:mybatis-config.xml
      #启动时是否检查 MyBatis XML 文件的存在，默认不检查
      check-config-location: false
      global-config:
        db-config: #配置逻辑删除
          logic-delete-value: 1 # 逻辑已删除值(默认为 1)
          logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
          #id-type: none #全局策略
          #field-strategy: ignored #所有字段加入crud语句中 一般不这么设置 默认not_null
          #table-prefix: t_ #表的前缀
          #table-underline: true #表名是否使用下划线
        #configuration:#不能与config-location同时出现
        #map-underscore-to-camel-case: true
    #设置日志 级别
    logging:
      level:
        root: warn
        com.hlvy.mybatis_plus: trace
      pattern:
        console: '%P%m%n'

启动类

package com.hlvy.mybatis_plus;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @MapperScan("com.hlvy.mybatis_plus.mapper")
    public class MybatisPlusApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(MybatisPlusApplication.class, args);
        }
    
    }

userMapper

package com.hlvy.mybatis_plus.mapper;
    
    import com.baomidou.mybatisplus.core.conditions.Wrapper;
    import com.baomidou.mybatisplus.core.mapper.BaseMapper;
    import com.baomidou.mybatisplus.core.metadata.IPage;
    import com.baomidou.mybatisplus.core.toolkit.Constants;
    import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
    import com.hlvy.mybatis_plus.entity.User;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    
    import java.util.List;
    
    /**
     * UserMapper
     *
     * @author heng
     **/
    
    public interface UserMapper extends BaseMapper<User> {
    
       /* @Select("select * from user ${ew.customSqlSegment}")*/
       List<User> selectAll(@Param(Constants.WRAPPER) Wrapper<User> wrapper);
    
    
       IPage<User> selectUserPage(Page<User> page,@Param(Constants.WRAPPER) Wrapper<User> wrapper);
    }

[https_github.com_heng1234_mybatis_plus]: https://github.com/heng1234/mybatis_plus