使Mybatis开发变得更加轻松的增强工具 — Ourbatis

一、Mybatis的不足之处

Mybatis是一款优秀的及其灵活的持久层框架,通过XML配置并映射到Mapper接口为Service层提供基础数据操作入口。

这么优秀的框架竟然还有不足之处?

俗话说人无完人,因为Mybatis实在是太灵活了,灵活到每个Mapper接口都需要定制对应的XML,所以就会引发一些问题。

问题一:配置文件繁多

假如一个系统中DB中涉及100张表,我们就需要写100个Mapper接口,还没完,最可怕的是,我们要为这100个Mapper接口定制与之对应的100套XML。而每个Mapper都必不可少的需要增删改查功能,我们就要写100遍增删改查,作为高贵的Java开发工程师,这是不能容忍的,于是Mybatis Generator诞生了,然而又会引发另一个问题!

问题二:维护困难

我们使用Mybatis Generator解决了问题一,再多的文件生成就是了,简单粗暴,貌似解决了所有的问题,Mybatis完美了!

不要高兴的太早,在系统刚刚建立起来时,我们使用Mybatis Generator生成了一堆XML,在开发过程中,产品忽然提了一个新的需求,项目经理根据这个需求在某张表中增加或变动了一个字段,这时,我猜你的操作是这样:

  • 1、找到对应表的XML
  • 2、将该XML中自定义的一段标签复制出来,保存在本地
  • 3、使用Mybatis Generator重新生成该表的XML
  • 4、将之覆盖当前的XML
  • 5、将自定义的一段标签再粘贴进新的XML中

在这个过程中,如果我们在第2步时漏复制了一段标签,等整个操作完成之后,又别是一番滋味在心头~

问题三:编写XML困难

假如肝不错,问题二也是小CASE,那么问题又来了,我们如何在繁长的XML中去编写和修改我们的XML呢。

当我们打开要编辑的XML,映入眼帘的就是1000多行的XML,其中900行都是通用的增删改查操作,要新增一个标签,我们需要拉至文件底部编写新的数据操作,要更新一个标签,我们需要通过Ctrl + F寻找目标标签再进行修改。

如何避免这些问题呢?

如何让Mybatis增强通用性又不失灵活呢?

二、使用Ourbatis辅助Mybatis

Ourbatis是一款Mybatis开发增强工具,小巧简洁,项目地址:

  • Github:https://github.com/ainilili/ourbatis
  • Gitee:https://gitee.com/ainilili/ourbatis
  • Wiki:https://github.com/ainilili/ourbatis/wiki
  • Demo:https://github.com/ainilili/ourbatis-simple

特性:

  • 1、简洁方便,可以让Mybatis无XML化开发。
  • 2、优雅解耦,通用和自定义的SQL标签完全隔离,让维护更加轻松。
  • 3、无侵入性,Mybatis和Ourbatis可同时使用,配置简洁。
  • 4、灵活可控,通用模板可自定义及扩展。
  • 5、部署快捷,只需要一个依赖,两个配置,即可直接运行。
  • 6、多数据源,在多数据源环境下也可以照常使用。

关于Ourbatis使用的一个小Demo

环境:

  • Spring Boot 2.0.5.RELEASE
  • Ourbatis 1.0.5
  • JAVA 8
  • Mysql

Spring Boot 2.0.5.RELEASE版本为例,在可以正常使用Mybatis的项目中,pom.xml添加如下依赖:

   
           com.smallnico
           ourbatis-spring-boot-starter
           1.0.5
   

在配置文件中增加一下配置:

ourbatis.domain-locations=实体类所在包名

接下来,Mapper接口只需要继承SimpleMapper即可:

import org.nico.ourbatis.domain.User;
public interface UserMapper extends SimpleMapper{
}

至此,一个使用Ourbatis的简单应用已经部署起来了,之后,你就可以使用一些Ourbatis默认的通用操作方法:

    public T selectById(K key);
    
    public T selectEntity(T condition);
    
    public List selectList(T condition);
    
    public long selectCount(Object condition);
    
    public List selectPage(Page page);
    
    default PageResult selectPageResult(Page page){
        long total = selectCount(page.getEntity());
        List results = null;
        if(total > 0) {
            results = selectPage(page);
        }
        return new PageResult<>(total, results);
    }
    
    public K selectId(T condition);
    
    public List selectIds(T condition);
    
    public int insert(T entity);
    
    public int insertSelective(T entity);
    
    public int insertBatch(List list);
    
    public int update(T entity);
    
    public int updateSelective(T entity);
    
    public int updateBatch(List list);
    
    public int delete(T condition);
    
    public int deleteById(K key);
    
    public int deleteBatch(List list);
 
 

Mapper自定义方法

在很多场景中,我们使用以上的自带的通用方法远远不能满足我们的需求,我们往往需要额外扩展新的Mapper方法、XML标签,我们使用了Ourbatis之后该如何实现呢?

首先看一下我们的需求,在上述Demo中,我们在UserMapper中增加一个方法selectNameById

import org.nico.ourbatis.domain.User;
public interface UserMapper extends SimpleMapper{
    public String selectNameById(Integer userId);
}

和Mybatis一样,需要在resources资源目录下新建一个文件夹ourbatis-mappers,然后在其中新建一个XML文件,命名规则为:

DomainClassSimpleName + Mapper.xml

其中DomainClassSimpleName就是我们实体类的类名,这里是为User,那么新建的XML名为UserMapper.xml

src/main/resources
 - ourbatis-mappers
   - UserMapper.xml

之后,打开UserMapper.xml,开始编写Mapper中selectNameById方法对应的标签:


注意,整个文件中只需要写标签就行了,其他的什么都不需要,这是为什么呢?深入之后你就会明白,这里先不多说!

接下来,就没有接下来了,可以直接使用selectNameById方法了。

深入了解Ourbatis

ourbatis 流程图

当服务启动的时候,Ourbatis首先会扫描ourbatis.domain-locations配置包下的所有实体类,将之映射为与之对应的表结构数据:

ourbatis Mapping

然后通过ourbatis.xml的渲染,生成一个又一个的XML文件,最后将之重新Build到Mybatis容器中!

整个过程分为两个核心点:

  • 1、映射实体类为元数据
  • 2、使用ourbatis.xml渲染元数据为XML文件

我会一一介绍之~

映射实体类为元数据

在映射时,我们要根据自己数据库字段命名的风格去调整映射规则,就需要在第1个核心点中去做处理,Ourbatis使用包装器来完成:

public interface Wrapper {
    public String wrapping(T value);
}

对于需要映射的字段,如表名表字段名,它们都将会经过一个包装器链条的处理之后再投入到ourbatis.xml中做渲染,这样就使得我们可以自定义包装器出更换映射的字段格式,具体方式可以参考官方Wiki:Wrapper包装器

使用ourbatis.xml渲染元数据为XML文件

而在于第2个核心点中,Ourbatis通过自定义标签做模板渲染,我们可以先看一下官方默认的ourbatis.xml内部构造:




    
        
            
        
        
            
        
    

    
        
            `@{elem.jdbcName}`
        
    

    

    

    

    

    

    

    

    
        delete
        from @{tableName}
        where 1=1
        
            and `@{elem.jdbcName}` = #{@{elem.javaName}}
        
    

    
        insert into @{tableName}
        (
        
        )
        values (
        
            #{@{elem.javaName}}
        
        )
    

    
        insert into @{tableName}
        (
        
            `@{elem.jdbcName}`
        
        
            
                ,`@{elem.jdbcName}`
            
        
        )
        values (
        
            #{@{elem.javaName}}
        
        
            
                , #{@{elem.javaName}}
            
        
        )
    

    
        insert into @{tableName}
        (
        
        )
        values
        
            (
            
                #{item.@{elem.javaName}}
            
            )
        
    

    
        update @{tableName}
        
            
                `@{elem.jdbcName}` = #{@{elem.javaName}}
            
        
        where 1=1
        
            and `@{elem.jdbcName}` = #{@{elem.javaName}}
        
    

    
        update @{tableName}
        
            
                `@{elem.jdbcName}` = #{@{elem.javaName}}
            
            
                
                    ,`@{elem.jdbcName}` = #{@{elem.javaName}}
                
            
        
        where 1=1
        
            and `@{elem.jdbcName}` = #{@{elem.javaName}}
        
    

    
        
            update @{tableName}
            
                
                    `@{elem.jdbcName}` = #{item.@{elem.javaName}}
                
            
            where 1=1
            
                and `@{elem.jdbcName}` = #{item.@{elem.javaName}}
            
        
    

    
        delete from @{tableName} where @{primaryColumns.0.jdbcName} in
        
            #{item}
        
    

    
        delete from @{tableName} where 1 = 1
        
            
                and `@{elem.jdbcName}` = #{@{elem.javaName}}
            
        
    

    

可以看出来,ourbatis.xml内容类似于原生的Mybatis的XML,不同的是,有两个陌生的标签:

  • ourbatis:foreach 对元数据中的列表进行循环渲染
  • ourbatis:ref 引入外界文件内容

这是Ourbatis中独有的标签,Ourbatis也提供着对应的入口让我们去自定义标签:

Class: org.nico.ourbatis.Ourbatis
Field: 
public static final Map ASSIST_ADAPTERS = new HashMap(){
        private static final long serialVersionUID = 1L;
        {
            put("ourbatis:foreach", new ForeachAdapter());
            put("ourbatis:ref", new RefAdapter());
        }
    };

我们可以修改org.nico.ourbatis.Ourbatis类中的静态参数ASSIST_ADAPTERS去删除、更新和添加自定义标签,需要实现一个标签适配器,我们可以看一下最简单的RefAdapter适配器的实现:

public class RefAdapter extends AssistAdapter{
    @Override
    public String adapter(Map datas, NoelRender render, Document document) {
        String path = render.rending(datas, document.getParameter("path"), "domainSimpleClassName");
        String result =  StreamUtils.convertToString(path.replaceAll("classpath:", ""));
        return result == null ? "" : result.trim();
    }
}

Ourbatis中只定义了上述两个自定义标签已足够满足需求,通过foreach标签,将元数据中的集合遍历渲染,通过ref标签引入外界资源,也就是我们之前所说的对Mapper接口中方法的扩展!


其中的path就是当前项目classpath路径的相对路径,而@{domainSimpleClassName}就代表着实体类的类名,更多的系统参数可以参考Wiki:元数据映射

通过这种模板渲染的机制,Ourbatis是相当灵活的,我们不仅可以通过引入外部文件进行扩展,当我们需要添加或修改通用方法时,我们可以可以自定义ourbatis.xml的内容,如何做到呢?复制一份将之放在资源目录下就可以了!

看到这里,相信大家已经知道Ourbatis的基本原理已经使用方式,我就再次不多说了,更多细节可以去官方Wiki中阅读:Ourbtis Wiki

你可能感兴趣的:(使Mybatis开发变得更加轻松的增强工具 — Ourbatis)