首页 > 代码库 > mybatis注解详解
mybatis注解详解
mybatis的原身是ibatis，现在已经脱离了apache基金会，新官网是http://www.mybatis.org/。
mybatis3中增加了使用注解来配置Mapper的新特性，本篇文章主要介绍其中几个@Provider的使用方式，他们是：@SelectProvider、@UpdateProvider、@InsertProvider和@DeleteProvider。
MyBatis 3 User Guide中的最后一章描述了注解的简单用法，但是对于这几个Provider的具体使用方式并没有说的很清楚，特别是参数传递的方式，完全没有提及，对于初次使用的同学来说，会造成不小的困扰。
经过一些尝试后，我总结了一些Provider的使用经验，下面以@SelectProvider为例，依次描述几种典型的使用场景。
1.使用@SelectProvider
MyBatis 3 User Guide中的最后一章描述了注解的简单用法，但是对于这几个Provider的具体使用方式并没有说的很清楚，特别是参数传递的方式，完全没有提及，对于初次使用的同学来说，会造成不小的困扰。
经过一些尝试后，我总结了一些Provider的使用经验，下面以@SelectProvider为例，依次描述几种典型的使用场景。
1.使用@SelectProvider
@SelectProvider是声明在方法基本上的，这个方法定义在Mapper对应的的interface上。
这是一个很简单很常用的查询场景：根据key来查询记录并将结果封装成实体bean。其中：
1 public interface UserMapper {
2 @SelectProvider(type = SqlProvider.class, method = "selectUser")
3 @ResultMap("userMap")
4 public User getUser(long userId);
5 }
上例中是个很简单的Mapper接口，其中定义了一个方法：getUser，这个方法根据提供的用户id来查询用户信息，并返回一个User实体bean。2 @SelectProvider(type = SqlProvider.class, method = "selectUser")
3 @ResultMap("userMap")
4 public User getUser(long userId);
5 }
这是一个很简单很常用的查询场景：根据key来查询记录并将结果封装成实体bean。其中：
@SelectProvider注解用于生成查询用的sql语句，有别于@Select注解，@SelectProvide指定一个Class及其方法，并且通过调用Class上的这个方法来获得sql语句。在我们这个例子中，获取查询sql的方法是SqlProvider.selectUser。
@ResultMap注解用于从查询结果集RecordSet中取数据然后拼装实体bean。
@ResultMap注解用于从查询结果集RecordSet中取数据然后拼装实体bean。
2.定义拼装sql的类
@SelectProvide中type参数指定的Class类，必须要能够通过无参的构造函数来初始化。
@SelectProvide中method参数指定的方法，必须是public的，返回值必须为String，可以为static。
1 public class SqlProvider {
2 public String selectUser(long userId) {
3 return "select * from user where userId=" + userId;
4 }
5 }
2 public String selectUser(long userId) {
3 return "select * from user where userId=" + userId;
4 }
5 }
3.无参数@SelectProvide方法
在Mapper接口方法上和@SelectProvide指定类方法上，均无参数：
UserMapper.java：
1 @SelectProvider(type = SqlProvider.class, method = "selectAllUser")
2 @ResultMap("userMap")
3 public List<User> getAllUser();
2 @ResultMap("userMap")
3 public List<User> getAllUser();
SqlProvider.java：
1 public String selectAllUser() {
2 return "select * from user";
3 }
2 return "select * from user";
3 }
4.一个参数的@SelectProvide方法
对于只有一个参数的情况，可以直接使用，参见前面的getUser和selectUser。
但是，如果在getUser方法中，对userId方法使用了@Param注解的话，那么相应selectUser方法必须接受Map<String, Object>做为参数：
UserMapper.java：
1 @SelectProvider(type = SqlProvider.class, method = "selectUser2")
2 @ResultMap("userMap")
3 public User getUser2(@Param("userId") long userId);
2 @ResultMap("userMap")
3 public User getUser2(@Param("userId") long userId);
SqlProvider.java：
1 public String selectUser2(Map<String, Object> para) {
2 return "select * from user where userId=" + para.get("userId");
3 }
2 return "select * from user where userId=" + para.get("userId");
3 }
5.更多参数的@SelectProvide方法
在超过一个参数的情况下，@SelectProvide方法必须接受Map<String, Object>做为参数，
如果参数使用了@Param注解，那么参数在Map中以@Param的值为key，如下例中的userId；
如果参数没有使用@Param注解，那么参数在Map中以参数的顺序为key，如下例中的password：
UserMapper.java：
1 @SelectProvider(type = SqlProvider.class, method = "selectUserCheck")
2 @ResultMap("userMap")
3 public User getUserCheck(@Param("userId") long userId, String password);
2 @ResultMap("userMap")
3 public User getUserCheck(@Param("userId") long userId, String password);
SqlProvider.java：
6.一些限制
在Mapper接口和@SelectProvide方法类中，不要使用重载，也就是说，不要使用方法名相同参数不同的方法，以避免发生诡异问题。
1 public String selectUserCheck(Map<String, Object> para) {
2 return "select * from user where userId=" + para.get("userId") + " and password=‘" + para.get("1") + "‘";
3 }
2 return "select * from user where userId=" + para.get("userId") + " and password=‘" + para.get("1") + "‘";
3 }
6.一些限制
在Mapper接口和@SelectProvide方法类中，不要使用重载，也就是说，不要使用方法名相同参数不同的方法，以避免发生诡异问题。
http://www.blogjava.net/dbstar/archive/2011/08/08/355825.html
最近在总结过去一年所做的项目，由于开发周期或者对需求的把握不是太到位，每个项目随着所做的项目进度，从需求分析到code阶段总或多或少有一些自己感觉不是太完美或没有尽善尽美的地方，使用开源框架和第三方接口只知道接口调用，对于其内部实现机理总是存在疑惑（这家伙是怎么做的，我怎么没有想到），虽然各个项目完成后一瘸一拐的还是能满足当初的开发需求。但是对于追求完美、刨根问底性选手，心中总有根刺，感觉不爽(不知道大家有没有这种感觉)。下面通过自己的理解使用java原生的注解方式实现 spring aop的运行机理 (还没看过spring /mybatis的源代码，过年的时候研究一下大侠们有好的想法可以共享一下，话说独乐乐不如众乐乐哦）
先说说spring AOP使用上的一些限制:
1.如果切点函数有重载时，定义的通知类中方法不能实现方法重载
2.spring AOP只支持方法层面的切口定义，当然这个也是spring的基本原则如spring mvc 与struts2的区别之一就是spring mvc是基于方法的设计struts2是基于类的设计；
3.spring aop 不支持参数级的切口定义，如有时候需要对传入切口的参数进行安全性，规范性、合法性处理的时候是不支持的。当然对参数处理涉及到解析参数类型获取、参数类型判断，对于使用反射机制获取这个是有一定难度滴。
下面通过详细的代码，来讲解如何通过使用java的annotation自定义切点接口和通过反射机制实现spring AOP机制。
第一步:自定义AOP中需要的注解接口
class层注解定义：
用途：类接口切点注解定义
package com.dbc.yangg.project;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * * @ClassName: MyClassAnnotation * @Description: 类层注解定义 * @author guoyang2011@gmail.com * @date 2014年1月18日 下午11:37:51 * */@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)public @interface MyClassAnnotation { String value() default "firstAnno";}
method层advice定义类似于Spring AOP中@Before,@After,@Around,@AfterThrowing,@AfterReturning等
用途：方法切点接口注解定义
package com.dbc.yangg.project;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * * @ClassName: MySecondMethodAnnotation * @Description: 方法层注解定义 * @author guoyang2011@gmail.com * @date 2014年1月18日 下午11:44:44 * */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface MyPointcutAnnotation { /** * * @Title: className * @Description: TODO * @param @return advicer class type * @return Class<?> * @throws */ Class<?> className(); /** * * @Title: method * @Description: TODO * @param @return advicer method name * @return String * @throws */ String method();//}
method parameters 层advicer定义类似mybatis中@Param注解
功能:参数层面切点接口注解定义
package com.dbc.yangg.project;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * * @ClassName: MyParameterAnnotation * @Description: 方法中参数层注解定义 * @author guoyang2011@gmail.com * @date 2014年1月18日 下午11:45:15 * */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.PARAMETER)public @interface MyParameterAnnotation { /** * * @Title: opType * @Description: method 参数类型检查 * @param @return * @return MyAopParameterOPType[] * @throws */ MyAopParameterOPType[] opType(); /** * * @Title: paraType * @Description: method 参数类型 * @param @return * @return Class<?> * @throws */ Class<?> paraType();}
处理MyAopParameterOPType类型定义
功能:定义参数切口定义注解处理的类型
package com.dbc.yangg.project; /** * * @ClassName: MyAopParameterOPType * @Description: TODO * @author guoyang2011@gmail.com * @date 2014年1月18日 下午12:07:25 * */public enum MyAopParameterOPType { checkForDB("DB"),//特殊字符处理 ,通用转码或者其他处理 checkForSecurity("security"),//参数是否合法等操作 checkDeleteAuthority("DeleteAuthority"), checkUpdateAuthority("UpdateAuthority"); private String value; private MyAopParameterOPType(String value){ this.value=http://www.mamicode.com/value;"indent"> } public String getValue(){ return this.value; }}
第二步:自定义AOP管理模块
主要功能:自定义AOP处理类，负责解析实际调用切点函数定义的通知
package com.dbc.yangg.project;import java.lang.annotation.Annotation;import java.lang.reflect.InvocationTargetException;import java.lang.reflect.Method;import org.apache.ibatis.annotations.SelectProvider;/** * * @ClassName: MyAOPUtils * @Description: * @author guoyang2011@gmail.com * @date 2014年1月18日 下午12:01:05 * */public class MyAOPUtils { /** * * @Title: myAopUtilsManager * @Description: 切点函数参数触发通知事件,所有通知事件的处理接口 * @param @param advicerManagerClass * @param @param indexArg * @param @param paraValues * @param @param paraTypes * @param @return * @return boolean * @throws */ private static boolean parameterAdvicerUtils(Annotation advicerManagerClass,int indexArg,Object[] paraValues, Class<?>... paraTypes){ if(advicerManagerClass instanceof MyPointcutAnnotation){ //接口参数验证通过后执行 //切点通知处理 MyPointcutAnnotation AdvicerClass=(MyPointcutAnnotation)advicerManagerClass; Class<?> adviceClass=AdvicerClass.className(); try { Method adviceMethod=adviceClass.getMethod(AdvicerClass.method(),paraTypes); adviceMethod.invoke(adviceClass.newInstance(), paraValues); } catch (NoSuchMethodException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (SecurityException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (IllegalAccessException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (IllegalArgumentException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (InvocationTargetException e) { // TODO Auto-generated catch block e.printStackTrace(); } catch (InstantiationException e) { // TODO Auto-generated catch block e.printStackTrace(); } }else if(advicerManagerClass instanceof MyParameterAnnotation){ //对输入的参数做一些通用处理和安全性检查等等 //一般用在DAO层sql拼装特殊字符检查，数据格式合法性检查，转码或对调用者使用定义切点接口使用权限，安全性，等信息进行检查和确认等场合；当切点参数通过通知类中定义的接口处理后再调用切点方法；如MyBatis中通过注解@SelectProvider方式生成合法的SQL语句需要对拼装的sql语句传入的参数进行验证等，还有就是从安全新考虑对传入的模块调用者身份进行检查，MyBatis通过注解方式定义接口实现动态SQL生成中关键就是对数据类型的解析 if(indexArg<0){ return true; } MyParameterAnnotation AdvicerClass=(MyParameterAnnotation)advicerManagerClass; //处理切点方法参数的通知，大概思路如下： //1.解析参数类型 //2.获取参数值 //3.调用通知处理接口检查参数合法性 //4.返回检查结果 true:false } return true; } /** * * @Title: myAopUtilsManager * @Description: Pointcut method execute advice interface * @param @param advicerManagerClass 类型 * @param @param paraValues pointcut传入参数 * @param @param paraTypes pointcut传入参数类型 * @return void * @throws */ private static boolean methodAdvicerUtils(Annotation advicerManagerClass,Object[] paraValues, Class<?>... paraTypes){