MyBatis JPA Extra

MyBatis JPA Extra对MyBatis扩展JPA功能

1.Jakarta JPA 3注释简化CUID操作;

2.增强SELECT分页查询;

3.链式Query查询条件构造器；支持Lambda 形式调用，方便编写各类查询条件

4.@Encrypted注解轻松实现字段数据加密和解密;

5.字段数据自动填充功能;

6.数据库支持

代码托管

| GitCode | Gitee |GitHub |

1、JPA 3注释

1.1、注释

• @Entity
• @Table
• @Column
• @ColumnDefault
• @Id
• @GeneratedValue
• @Encrypted
• @Transient
• @Temporal
• @PartitionKey
• @SoftDelete

1.2、主键策略

支持3种主键策略

1.3、Java Bean 注释

@Entity
@Table(name = "STUDENTS")  
public class Students extends JpaEntity implements Serializable{
    @Id
    @Column
    @GeneratedValue
    private String id;
    @Column
    private String stdNo;
    @Column
    @Encrypted
    private String password;
    @Column
    private String stdName;
    @Column
    @ColumnDefault("'M'")
    private String stdGender;
    @Column
    private int stdAge;
    @Column
    private String stdMajor;
    @Column
    private String stdClass;
    @Column
    private byte[] images;
    @Column(insertable = false)
    @GeneratedValue
    @Temporal(TemporalType.TIMESTAMP)
    private LocalDateTime modifyDate;
    @SoftDelete
    @Column(name ="is_deleted")
    private int isDeleted;
    //getter setter
}

2、基本操作

2.1、CURD

    //新增数据
    @Test
    void insert() throws Exception{
        Students student = new Students();
        student.setStdNo("10024");
        student.setStdGender("M");
        student.setStdName("司马昭");
        student.setStdAge(20);
        student.setStdMajor("政治");
        student.setStdClass("4");
        service.insert(student);
    }
    //查询数据实体并更新
    @Test
    void update() throws Exception{
        Students student = service.get("317d5eda-927c-4871-a916-472a8062df23");
        student.setStdMajor("政治");
        service.update(student);
    }
    //根据实体查询并更新
    @Test
    void merge() throws Exception{
        Students student = new Students();
        student.setStdMajor("政治");
        student.setStdClass("4");
        service.merge(student);
    }
    //根据ID查询
    @Test
    void get() throws Exception{
        Students student = service.get("317d5eda-927c-4871-a916-472a8062df23");
    }
    //根据实体查询
    @Test
    void query() throws Exception{
        Students student = new Students();
        student.setStdGender("M");
        List listStudents = service.query(student);
    }
    //查询所有记录
    @Test
    void findAll() throws Exception{
        List listStudents = service.findAll();
    }
    //根据ID删除
    @Test
    void delete() throws Exception{
        service.delete("921d3377-937a-4578-b1e2-92fb23b5e512");
    }
    //根据ID集合批量删除
    @Test
    void batchDelete() throws Exception{
        List idList = new ArrayList();
        idList.add("8584804d-b5ac-45d2-9f91-4dd8e7a090a7");
        idList.add("ab7422e9-a91a-4840-9e59-9d911257c918");
        //...
        service.deleteBatch(idList);
    }

2.2、逻辑删除

    //根据IDS批量逻辑删除
    @Test
    void softDelete() throws Exception{
        List idList=new ArrayList();
        idList.add("8584804d-b5ac-45d2-9f91-4dd8e7a090a7");
        idList.add("ab7422e9-a91a-4840-9e59-9d911257c918");
        //...
        service.softDelete(idList);
    }

2.3、Find查询和Qruey构造器

    //SpringJDBC的查询方式 where StdNo = '10024' or StdNo = '10004'
    @Test
    void find() throws Exception{
        List listStudents = service.find(" StdNo = ? or StdNo = ?  ",
                            new Object[]{"10024","10004"},
                            new int[]{Types.VARCHAR,Types.INTEGER}
                        );
    }
    //根据链式条件构造器查询
    //WHERE (stdMajor = '政治' and STDAGE > 30 and stdMajor in ( '政治' , '化学' )  or  ( stdname = '周瑜' or stdname = '吕蒙' ) )
    @Test
    void queryByCondition() throws Exception{
        List listStudents = service.query(
                new Query().eq("stdMajor", "政治").and().gt("STDAGE", 30).and().in("stdMajor", new Object[]{"政治","化学"})
                .or(new Query().eq("stdname", "周瑜").or().eq("stdname", "吕蒙")));
    }

2.4、单表分页查询

    //根据实体分页查询
    @Test
    void fetch() throws Exception{
         JpaPage page = new JpaPage(1);
         Students student = new Students();
         student.setStdGender("M");
         JpaPageResults  results = service.fetch(page,student);
    }
    //根据Query条件分页查询 where stdMajor = '政治' and STDAGE > 30
    @Test
    void fetchByCondition() throws Exception{
         JpaPage page = new JpaPage(1,20);
         Query condition = new Query().eq("stdMajor", "政治").and().gt("STDAGE", 30);
         JpaPageResults  results = service.fetch(page,condition);
    }

2.5、根据mapper的xml分页查询

    //根据Mapper xml配置fetchPageResults分页查询
    @Test
    void fetchPageResults() throws Exception{
         Students student=new Students();
         student.setStdGender("M");
         student.setPageNumber(1);
         JpaPageResults  results = service.fetchPageResults(student);
    }
    //根据Mapper xml id分页查询,fetchPageResults1在mapper的xml中配置
    @Test
    void fetchPageResultsByMapperId() throws Exception{
         Students student=new Students();
         student.setStdGender("M");
         student.setPageNumber(1);
         JpaPageResults results = service.fetchPageResults("fetchPageResults1",student);
    }

2.6、 Lambda查询

    //根据Lambda链式条件构造器查询
    //WHERE (stdMajor = '政治' and STDAGE > 30 and stdMajor in ( '政治' , '化学' )  or  ( stdname = '周瑜' or stdname = '吕蒙' ) )
    service.query(
                new LambdaQuery().eq(Students::getStdMajor, "政治")
                                     .and().gt(Students::getStdAge, Integer.valueOf(30))
                                     .and().in(Students::getStdMajor, new Object[]{"政治","化学"})
                                     .or(
                                            new LambdaQuery().eq(Students::getStdName, "周瑜")
                                                                  .or().eq(Students::getStdName, "吕蒙")
                                        )
                );

    //根据Lambda链式条件构造器分页查询
    //where stdMajor = '政治' and stdAge > 30
    JpaPage page = new JpaPage();
    page.setPageSize(20);
    page.setPageable(true);
    LambdaQuery lambdaQuery =new LambdaQuery<>();
    lambdaQuery.eq(Students::getStdMajor, "政治").and().gt(Students::getStdAge, Integer.valueOf(30));
    JpaPageResults  results = service.fetch(page,lambdaQuery);

    ...

2.6、 UpdateWrapper更新

    //根据UpdateWrapper更新数据
    UpdateWrapper updateWrapper = new UpdateWrapper();
    updateWrapper.set("StdMajor", "历史").eq("StdName", "周瑜").or().eq("StdName", "吕蒙");   
    service.update(updateWrapper);

    //更新LambdaUpdateWrapper更新数据，带多重LambdaUpdateWrapper
    List majorList = new ArrayList<>(Arrays.asList("政治","化学"));
    LambdaUpdateWrapper updateWrapper = new LambdaUpdateWrapper<>();
    updateWrapper.set(Students::getStdMajor, "历史")
                 .eq(Students::getStdMajor, "政治")
                 .and().gt(Students::getStdAge, Integer.valueOf(30))
                 .and().in(Students::getStdMajor, majorList)
                 .or(new LambdaUpdateWrapper().eq(Students::getStdName, "周瑜").or().eq(Students::getStdName, "吕蒙"));
        
    service.update(updateWrapper);

2.8、FindBy查询

实现spring data jpa的findBy功能

    //Mapper接口定义
    //where x.stdNo = ?1
    @Select({})
    public List findByStdNo(String stdNo);
    //where x.stdNo = ?1
    @Select({})
    public List findByStdNoIs(String stdNo);
    //where x.stdNo = ?1
    @Select({})
    public List findByStdNoEquals(String stdNo);
    //where x.stdAge between ?1 and ?2
    @Select({})
    public List findByStdAgeBetween(int ageStart,int ageEnd);
    //where x.stdAge < ?1
    @Select({})
    public List findByStdAgeLessThan(int ageLessThan);
    //where x.stdAge <= ?1
    @Select({})
    public List findByStdAgeLessThanEqual(int ageLessThanEqual);
    //where x.stdAge > ?1
    @Select({})
    public List findByStdAgeAfter(int ageAfter);
    //where x.stdAge < ?1
    @Select({})
    public List findByStdAgeBefore(int ageBefore);
    //where x.images is null
    @Select({})
    public List findByImagesNull();
    //where x.images is null
    @Select({})
    public List findByImagesIsNull();
    //where x.images is not null
    @Select({})
    public List findByImagesIsNotNull();
    //where x.images is not null
    @Select({})
    public List findByImagesNotNull();
    //where x.stdName like ?1
    @Select({})
    public List findByStdNameLike(String stdName);
    //where x.stdName not like ?1
    @Select({})
    public List findByStdNameNotLike(String stdName);
    //where x.stdName like ?1 (parameter bound with appended %)
    @Select({})
    public List findByStdNameStartingWith(String stdName);
    //where x.stdName like ?1 (parameter bound with prepended %)
    @Select({})
    public List findByStdNameEndingWith(String stdName);
    //where x.stdName like ?1 (parameter bound wrapped in %)
    @Select({})
    public List findByStdNameContaining(String stdName);
    //where x.stdGender = ?1 order by x.stdAge desc
    @Select({})
    public List findByStdGenderOrderByStdAge(String stdGender);
    //where x.stdGender = ?1 order by x.stdAge desc
    @Select({})
    public List findByStdGenderIsOrderByStdAge(String stdGender);
    //where x.stdMajors in ?1
    @Select({})
    public List findByStdMajorIn(String... stdMajors) ;
    //where x.stdMajors not in ?1
    @Select({})
    public List findByStdMajorNotIn(List stdMajors);
    //where x.deleted = true
    @Select({})
    public List findByDeletedTrue();
    //where x.deleted = false
    @Select({})
    public List findByDeletedFalse();
    //where UPPER(x.stdGender) = UPPER(?1)
    @Select({})
    public List findByStdGenderIgnoreCase(String stdGender);
    //where x.stdNo <> ?1
    @Select({})
    public List findByStdNoNot(String stdNo);
    //where x.lastname = ?1 and x.firstname = ?2
    @Select({})
    public List findByStdMajorAndStdClass(String stdMajor,String stdClass);

2.9、默认数据自动填充

继承FieldAutoFillHandler，实现insertFill和updateFill函数，可以完成租户字段，创建人、创建时间、修改人、修改时间等默认字段的填充

import org.apache.ibatis.reflection.MetaObject;
import org.dromara.mybatis.jpa.handler.FieldAutoFillHandler;

public class MxkFieldAutoFillHandler  extends FieldAutoFillHandler{

    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValue(metaObject , "stdNo", "AutoFill_Insert");
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValue(metaObject , "stdNo", "AutoFill_Update");
    }
}

3、mapper配置

    
        WHERE   1   =   1
        
            AND ID  =   '${id}'
        
        
            AND STDNAME like '%${stdName}%'
        
        
            AND STDGENDER   =   #{stdGender}
        
        
            
        
    
    
    
        SELECT 
            id , stdno , stdname ,stdgender , stdage , stdmajor , stdclass 
        FROM STUDENTS 
        
    
 
     
        SELECT 
            id , stdno , stdname ,stdgender , stdage , stdmajor , stdclass 
        FROM STUDENTS 
        
    
       
     
        SELECT 
            id , stdno , stdname ,stdgender , stdage , stdmajor , stdclass 
        FROM ROLES 
        
    

4、SpringBoot配置

#
spring.datasource.username=root
spring.datasource.password=maxkey
spring.datasource.url=jdbc:mysql://localhost/test?autoReconnect=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

mybatis.dialect=mysql
mybatis.type-aliases-package=org.apache.mybatis.jpa.test.entity
mybatis.mapper-locations=classpath*:/org/apache/mybatis/jpa/test/dao/persistence/xml/${mybatis.dialect}/*.xml
mybatis.table-column-escape=true
#mybatis.table-column-escape-char=`

5、本次发布更新

1、新增MetadataConstants

2、新增OrderType

3、新增多数据源切换

4、增加sql和map参数的操作IJpaSqlMapper 、IJpaSqlRepository 和JpaSqlRepositoryImpl

5、Map返回值的字段映射为驼峰格式，返回map大写问题，空值返回

6、增加builder包

7、代码优化

1、StringBuffer to StringBuilder
2、org.dromara.mybatis.jpa.provider.base
3、CASE_TYPE to CaseType
4、TABLE_COLUMN_CASE to MapperMetadata

8、依赖包升级

         <spring.version>6.2.11</spring.version>
         <springboot.version>3.4.10</springboot.version>
        
        <commons-collections.version>4.5.0</commons-collections.version>
        <beanutils.version>1.11.0</beanutils.version>
        <commons-dbcp2.version>2.13.0</commons-dbcp2.version>
        <commons-pool2.version>2.12.1</commons-pool2.version>
        <commons-io.version>2.20.0</commons-io.version>
        <commons-codec.version>1.19.0</commons-codec.version>
        <commons-lang3.version>3.17.0</commons-lang3.version>
        <commons-logging.version>1.3.5</commons-logging.version>
        <commons-text.version>1.14.0</commons-text.version>
        <xmlbeans.version>5.2.0</xmlbeans.version>
        
        <log4j.version>2.25.2</log4j.version>
        <slf4j2.version>2.0.17</slf4j2.version>
        <slf4j.version>1.7.36</slf4j.version>
        <jackson.version2>2.14.0</jackson.version2>
        <mysql.version>8.4.0</mysql.version>
        <ojdbc8.version>21.6.0.0.1</ojdbc8.version>
        <highgo.version>6.0.3.jre8</highgo.version>
        <postgresql.version>42.4.1</postgresql.version>
        <persistence.version>3.1.0</persistence.version>
        <mybatis.version>3.5.19</mybatis.version>
        <mybatis-spring.version>3.0.4</mybatis-spring.version>
        <druid.version>1.2.23</druid.version>

        <caffeine.version>3.2.2</caffeine.version>
        <joda-time.version>2.14.0</joda-time.version>
        <activation.version>2.1.4</activation.version>
        <aopalliance.version>1.0</aopalliance.version>
        <bouncycastle.version>1.81</bouncycastle.version>