【转载】Mybatis @xxxProvider 脚本组装器的使用

前言

为什么会写这篇文章, 因为在看到 MapperAnnotationBuilder 构造方法初始化时, 发现了四个从未见过的注解

1 2 3 4 5 6 7 8 9 10 11 12

public MapperAnnotationBuilder(Configuration configuration, Class<?> type) {   ...   sqlAnnotationTypes.add(Select.class);   sqlAnnotationTypes.add(Insert.class);   sqlAnnotationTypes.add(Update.class);   sqlAnnotationTypes.add(Delete.class);   // 这四个注解眼生的很   sqlProviderAnnotationTypes.add(SelectProvider.class);   sqlProviderAnnotationTypes.add(InsertProvider.class);   sqlProviderAnnotationTypes.add(UpdateProvider.class);   sqlProviderAnnotationTypes.add(DeleteProvider.class); }

@SelectProvider、@InsertProvider、@UpdateProvider、@DeleteProvider

分别是 mybatis 定义的 另类增删改查注解

02、介绍篇

四个注解中分别都有两个属性, 这里以 @SelectProvider举例

可以看到, 两个属性并没有默认值, 证明定义注解的话, 这两个属性必须组合使用

没有看到这一块的具体解析源码, 不过也能猜出来, 根据反射调用方法获取的返回值

1 2 3 4 5 6 7 8 9

@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface InsertProvider {   // 用于指定获取 sql 语句的指定类   Class<?> type();   // 指定类中要执行获取 sql 语句的方法   String method(); }

03、实战篇

如何根据注解定义 sql 语句呢, 首先定义 mapper 接口

1 2 3 4

public interface AutoConstructorMapper {   @SelectProvider(type = SubjectSqlProvider.class, method = "getSubjectTestProvider")   PrimitiveSubject getSubjectTestProvider(@Param("id") int id); }

@Param() 为必须, 在解析时会将参数定义为 map, 进行调用指定 method

创建 type 对应的存放 sql 语句的类, 以及定义返回 sql 语句的方法

有三点需要注意:

• 方法入参必须为 Map
• 方法的权限修饰符 必须是 public
• 方法返回的必须是拼接好的 sql 字符串

1 2 3 4 5 6 7 8 9

public class SubjectSqlProvider {   public String getSubjectTestProvider(Map<String, Object> params) {     return new SQL()         .SELECT("*")         .FROM("subject")         .WHERE("id = " + params.get("id"))         .toString();   } }

SQL 类是 mybatis 提供开发者在代码中灵活编写 sql 语句的工具类

04、思考篇

思考一下, @SelectProvider 注解, 与 @Select 注解解析流程有什么不同?

@Select 与 @SelectProvider 只是在定义注解的方式上有所不同, 一个是直接定义 sql, 一个是在外部定义好 sql 直接引用, 没有质的区别

在 mybatis 初始化定义 MappedStatement 时, 使用了两种不同的逻辑进行组装 SqlSource

1 2 3 4 5 6 7 8 9 10 11 12 13

Class<? extends Annotation> sqlAnnotationType = getSqlAnnotationType(method); Class<? extends Annotation> sqlProviderAnnotationType = getSqlProviderAnnotationType(method); if (sqlAnnotationType != null) {   if (sqlProviderAnnotationType != null) {     throw new BindingException("You cannot supply both a static SQL and SqlProvider to method named " + method.getName());   }   Annotation sqlAnnotation = method.getAnnotation(sqlAnnotationType);   final String[] strings = (String[]) sqlAnnotation.getClass().getMethod("value").invoke(sqlAnnotation);   return buildSqlSourceFromStrings(strings, parameterType, languageDriver); } else if (sqlProviderAnnotationType != null) {   Annotation sqlProviderAnnotation = method.getAnnotation(sqlProviderAnnotationType);   return new ProviderSqlSource(assistant.getConfiguration(), sqlProviderAnnotation, type, method); }

05、使用篇

这里介绍下 mybatis 具体编写 SQL 的三种形式, 以及介绍不同的方式对应的使用场景

5.1 @Select

这种方式能够定义简单的 sql, 不涉及复杂查询和多参数的场景, 类似下述方式

@Select 定义 sql 的方式是最简单的, 省去了定义 xml文件的繁琐, 也少了定义编写 @SelectProvider 对应类和方法的步骤

1	SELECT * FROM subject WHERE id = #{id}

5.2 @SelectProvider

这种方式编写sql适合编写中等长度, 简单的查询搭配 join、group、order…

SQL 工具类提供了这种简单的 API 语法, 还是比较方便的

如果不想使用 SQL 工具类, 自己编写 sql 字符串也是可以的

5.3 .xml 文件

这种方式就不多说了, 功能全部具备, 比如计算函数、动态SQL、各种关键字都支持

这几种方式都能够实现我们的 sql 编写需求, 只不过针对不同的场景, 合理的使用即可

06、总结篇

看 mybatis 源码, 对变量、方法的命名加深了感触, 一个好的变量或者方法命名在代码中是多么有必要getSqlSourceFromAnnotations 是不是要比 getSqlSource 要好理解很多, 看了之后就能让阅读者知道这个方法要做什么功能，到此这篇关于详解mybatis @SelectProvider 注解的文章就介绍到这了,更多相关mybatis