mapper注解的主要作用（@mapperscan 注解什么时候起作用）

本文目录

• @mapperscan 注解什么时候起作用
• @MapperScan注解
• 为什么使用@requestmapper注解
• 如何开发自己的通用Mapper

@mapperscan 注解什么时候起作用

mapperscan 一般在启动类的时候就会生效，来进行mapper包下接口的扫描，在编译后生成对象的实现类，还可以在mybatis配置文件中使用。

@MapperScan注解

说明：日常mybatis研发，需要在每个interface配置@Mapper，为了开发简便使用@MapperScan可以指定要扫描的Mapper类的包的路径 优势：避免每个interface增加注解，提升开发效率 场景：仅需加载application启动main即可 @MapperScan注解多个包 @MapperScan({"com.kfit.demo","com.kfit.user”}) 参考资料： ***隐藏网址*** ***隐藏网址*** 注意：包名   import tk.mybatis.spring.annotation.MapperScan; @Mapper和@MapperScan实际编码时可以选其一，建议@MapperScan可以避免每个dao增加配置

为什么使用@requestmapper注解

类似BeanUtil 很简单，如果两个javaBean之间，属性名相同，类型为基本类型，那么下面代码就OK了，基本没有学习曲线。 Mappermapper=newDozerBeanMapper();DestinationObjectdestObject=mapper.map(sourceObject,DestinationObject.class);orDe

如何开发自己的通用Mapper

第一步，创建HsqldbMapper《T》public interface HsqldbMapper《T》 {}这个接口就是我们定义的通用Mapper，具体的接口方法在**第三步**写。其他的Mapper可以继承这个HsqldbMapper《T》。第二部，创建HsqldbProviderpublic class HsqldbProvider extends MapperTemplate { //继承父类的方法 public HsqldbProvider(Class《?》 mapperClass, MapperHelper mapperHelper) { super(mapperClass, mapperHelper); }}这个类是实际处理操作的类，需要继承MapperTemplate，具体代码在**第四步**写。第三步，在HsqldbMapper《T》中添加通用方法这里以一个分页查询作为例子。 public interface HsqldbMapper { /** * 单表分页查询 * * @param object * @param offset * @param limit * @return */ @SelectProvider(type=HsqldbProvider.class,method = "dynamicSQL") List selectPage(@Param("entity") T object, @Param("offset") int offset, @Param("limit") int limit); }返回结果为List,入参分别为查询条件和分页参数。在Mapper的接口方法中，当有多个入参的时候建议增加@Param注解，否则就得用param1,param2...来引用参数。同时必须在方法上添加注解。查询使用SelectProvider，插入使用@InsertProvider，更新使用UpdateProvider，删除使用DeleteProvider。不同的Provider就相当于xml中不同的节点，如《select》,《insert》,《update》,《delete》。因为这里是查询，所以要设置为SelectProvider，这4个Provider中的参数都一样，只有type和method。type必须设置为实际执行方法的HasqldbProvider.class,method必须设置为"dynamicSQL"。通用Mapper处理的时候会根据type反射HasqldbProvider查找方法，而Mybatis的处理机制要求method必须是type类中只有一个入参，且返回值为String的方法。"dynamicSQL"方法定义在MapperTemplate中，该方法如下：public String dynamicSQL(Object record) { return "dynamicSQL";}这个方法只是为了满足Mybatis的要求，没有任何实际的作用。第四步，在HsqldbProvider中实现真正处理Sql的方法在这里有一点要求，那就是HsqldbProvider处理HsqldbMapper《T》中的方法时，方法名必须一样，因为这里需要通过反射来获取对应的方法，方法名一致一方面是为了减少开发人员的配置，另一方面和接口对应看起来更清晰。除了方法名必须一样外，入参必须是MappedStatement ms，除此之外返回值可以是void或者SqlNode之一。这里先讲一下通用Mapper的实现原理。通用Mapper目前是通过拦截器在通用方法第一次执行的时候去修改MappedStatement对象的SqlSource属性。而且只会执行一次，以后就和正常的方法没有任何区别。使用Provider注解的这个Mapper方法，Mybatis本身会处理成ProviderSqlSource(一个SqlSource的实现类），由于之前的配置，这个ProviderSqlSource种的SQL是上面代码中返回的"dynamicSQL"。这个SQL没有任何作用，如果不做任何修改，执行这个代码肯定会出错。所以在拦截器中拦截符合要求的接口方法，遇到ProviderSqlSource就通过反射调用如HsqldbProvider中的具体代码去修改原有的SqlSource。最简单的处理Mybatis SQL的方法是什么？就是创建SqlNode，使用DynamicSqlSource，这种情况下我们不需要处理入参，不需要处理代码中的各种类型的参数映射。比执行SQL的方式容易很多。有关这部分的内容建议查看通用Mapper的源码和Mybatis源码了解，如果不了解在这儿说多了反而会乱。下面在HsqldbProvider中添加public SqlNode selectPage(MappedStatement ms)方法：/** * 分页查询 * @param ms * @return */public SqlNode selectPage(MappedStatement ms) { Class《?》 entityClass = getSelectReturnType(ms); //修改返回值类型为实体类型 setResultType(ms, entityClass); List《SqlNode》 sqlNodes = new ArrayList《SqlNode》(); //静态的sql部分:select column ... from table sqlNodes.add(new StaticTextSqlNode("SELECT " + EntityHelper.getSelectColumns(entityClass) + " FROM " + tableName(entityClass))); //获取全部列 List《EntityHelper.EntityColumn》 columnList = EntityHelper.getColumns(entityClass); List《SqlNode》 ifNodes = new ArrayList《SqlNode》(); boolean first = true; //对所有列循环，生成《if test="property!=null"》 column = #{property}《/if》 for (EntityHelper.EntityColumn column : columnList) { StaticTextSqlNode columnNode = new StaticTextSqlNode((first ? "" : " AND ") + column.getColumn() + " = #{entity." + column.getProperty() + "} "); if (column.getJavaType().equals(String.class)) { ifNodes.add(new IfSqlNode(columnNode, "entity."+column.getProperty() + " != null and " + "entity."+column.getProperty() + " != ’’ ")); } else { ifNodes.add(new IfSqlNode(columnNode, "entity."+column.getProperty() + " != null ")); } first = false; } //将if添加到《where》 sqlNodes.add(new WhereSqlNode(ms.getConfiguration(), new MixedSqlNode(ifNodes))); //处理分页 sqlNodes.add(new IfSqlNode(new StaticTextSqlNode(" LIMIT #{limit}"),"offset==0")); sqlNodes.add(new IfSqlNode(new StaticTextSqlNode(" LIMIT #{limit} OFFSET #{offset} "),"offset》0")); return new MixedSqlNode(sqlNodes);}注：对这段代码感觉吃力的，可以对比本页最下面**结构**部分XML形式的查看。首先这段代码要实现的功能是这样，根据传入的实体类参数中不等于null（字符串也不等于’’)的属性作为查询条件进行查询，根据分页参数进行分页。先看这两行代码：//获取实体类型Class《?》 entityClass = getSelectReturnType(ms);//修改返回值类型为实体类型setResultType(ms, entityClass);首先获取了实体类型，然后通过setResultType将返回值类型改为entityClass，就相当于resultType=entityClass。这里为什么要修改呢？因为默认返回值是T，Java并不会自动处理成我们的实体类，默认情况下是Object，对于所有的查询来说，我们都需要手动设置返回值类型。对于insert,update,delete来说，这些操作的返回值都是int，所以不需要修改返回结果类型。之后从List《SqlNode》 sqlNodes = new ArrayList《SqlNode》();代码开始拼写SQL，首先是SELECT查询头，在EntityHelper.getSelectColumns(entityClass)中还处理了别名的情况。然后获取所有的列，对列循环创建《if entity.property!=null》column = #{entity.property}《/if》节点。最后把这些if节点组成的List放到一个《where》节点中。这一段使用属性时用的是 entity. + 属性名，entity来自哪儿？来自我们前面接口定义处的Param("entity")注解，后面的两个分页参数也是。如果你用过Mybatis，相信你能明白。之后在《where》节点后添加分页参数，当offset==0时和offset》0时的分页代码不同。最后封装成一个MixedSqlNode返回。返回后通用Mapper是怎么处理的，这里贴下源码：SqlNode sqlNode = (SqlNode) method.invoke(this, ms);DynamicSqlSource dynamicSqlSource = new DynamicSqlSource(ms.getConfiguration(), sqlNode);setSqlSource(ms, dynamicSqlSource);返回SqlNode后创建了DynamicSqlSource，然后修改了ms原来的SqlSource。第五步，配置通用Mapper接口到拦截器插件中《plugins》 《plugin interceptor="com.github.abel533.mapper.MapperInterceptor"》 《!--================================================--》 《!--可配置参数说明(一般无需修改)--》 《!--================================================--》 《!--UUID生成策略--》 《!--配置UUID生成策略需要使用OGNL表达式--》 《!--默认值32位长度:@java.util.UUID@randomUUID().toString().replace("-", "")--》 《!--《property name="UUID" value="@java.util.UUID@randomUUID().toString()"/》--》 《!--主键自增回写方法,默认值MYSQL,详细说明请看文档--》 《property name="IDENTITY" value="HSQLDB"/》 《!--序列的获取规则,使用{num}格式化参数，默认值为{0}.nextval，针对Oracle--》 《!--可选参数一共3个，对应0,1,2,分别为SequenceName，ColumnName,PropertyName--》 《property name="seqFormat" value="{0}.nextval"/》 《!--主键自增回写方法执行顺序,默认AFTER,可选值为(BEFORE|AFTER)--》 《!--《property name="ORDER" value="AFTER"/》--》 《!--支持Map类型的实体类，自动将大写下划线的Key转换为驼峰式--》 《!--这个处理使得通用Mapper可以支持Map类型的实体（实体中的字段必须按常规方式定义，否则无法反射获得列）--》 《property name="cameHumpMap" value="true"/》 《!--通用Mapper接口，多个用逗号隔开--》 《property name="mappers" value="com.github.abel533.mapper.Mapper,com.github.abel533.hsqldb.HsqldbMapper"/》 《/plugin》《/plugins》这里主要是**mappers**参数：《property name="mappers" value="com.github.abel533.mapper.Mapper,com.github.abel533.hsqldb.HsqldbMapper"/》 多个通用Mapper可以用逗号隔开。测试接下来编写代码进行测试。public interface CountryMapper extends Mapper《Country》,HsqldbMapper《Country》 {}在CountryMapper上增加继承HsqldbMapper《Country》。编写如下的测试：@Testpublic void testDynamicSelectPage() { SqlSession sqlSession = MybatisHelper.getSqlSession(); try { CountryMapper mapper = sqlSession.getMapper(CountryMapper.class); //带查询条件的分页查询 Country country = new Country(); country.setCountrycode("US"); List《Country》 countryList = mapper.selectPage(country, 0, 10); //查询总数 Assert.assertEquals(1, countryList.size()); //空参数的查询 countryList = mapper.selectPage(new Country(), 100, 10); Assert.assertEquals(10, countryList.size()); } finally { sqlSession.close(); }}测试输出日志如下：DEBUG - ==》 Preparing: SELECT ID,COUNTRYNAME,COUNTRYCODE FROM COUNTRY WHERE COUNTRYCODE = ? LIMIT ? DEBUG - ==》 Parameters: US(String), 10(Integer)TRACE - 《== Columns: ID, COUNTRYNAME, COUNTRYCODETRACE - 《== Row: 174, United States of America, USDEBUG - 《== Total: 1DEBUG - ==》 Preparing: SELECT ID,COUNTRYNAME,COUNTRYCODE FROM COUNTRY LIMIT ? OFFSET ? DEBUG - ==》 Parameters: 10(Integer), 100(Integer)TRACE - 《== Columns: ID, COUNTRYNAME, COUNTRYCODETRACE - 《== Row: 101, Maldives, MVTRACE - 《== Row: 102, Mali, MLTRACE - 《== Row: 103, Malta, MTTRACE - 《== Row: 104, Mauritius, MUTRACE - 《== Row: 105, Mexico, MXTRACE - 《== Row: 106, Moldova, Republic of, MDTRACE - 《== Row: 107, Monaco, MCTRACE - 《== Row: 108, Mongolia, MNTRACE - 《== Row: 109, Montserrat Is, MSTRACE - 《== Row: 110, Morocco, MADEBUG - 《== Total: 10测试没有任何问题。这里在来点很容易实现的一个功能。上面代码中：countryList = mapper.selectPage(new Country(), 100, 10);传入一个没有设置任何属性的Country的时候会查询全部结果。有些人会觉得传入一个空的对象不如传入一个null。我们修改测试代码看看结果。执行测试代码后抛出异常：Caused by: org.apache.ibatis.ognl.OgnlException: source is null for getProperty(null, "id") 为什么会异常呢，因为我们上面代码中直接引用的entity.property，在引用前并没有判断entity != null，因而导致了这里的问题。我们修改HsqldbProvider中的selectPage方法，将最后几行代码进行修改，原来的代码：//将if添加到《where》sqlNodes.add(new WhereSqlNode(ms.getConfiguration(), new MixedSqlNode(ifNodes)));修改后：//增加entity!=null判断IfSqlNode ifSqlNode = new IfSqlNode(new MixedSqlNode(ifNodes),"entity!=null");//将if添加到《where》sqlNodes.add(new WhereSqlNode(ms.getConfiguration(), ifSqlNode));之后再进行测试就没有问题了。