`

Mybatis 通用 CURD 示例

 
阅读更多

 

  1. /** 
  2.  * The test Mapper interface. 
  3.  *  
  4.  * @author HuangMin <a href="mailto:minhuang@hengtiansoft.com>send email</a> 
  5.  *  
  6.  * @since 1.6 
  7.  * @version 1.0 
  8.  *  
  9.  *          #~TestMapper.java 2011-9-23 : afternoon 10:51:40 
  10.  */  
  11. @CacheNamespace(size = 512)  
  12. public interface TestMapper {  
  13.   
  14.     /** 
  15.      * get test bean by UID. 
  16.      *  
  17.      * @param id 
  18.      * @return 
  19.      */  
  20.     @SelectProvider(type = TestSqlProvider.class, method = "getSql")  
  21.     @Options(useCache = true, flushCache = false, timeout = 10000)  
  22.     @Results(value = {  
  23.             @Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR),  
  24.             @Result(property = "testText", column = "test_text", javaType = String.class, jdbcType = JdbcType.VARCHAR) })  
  25.     public TestBean get(@Param("id") String id);  
  26.   
  27.     /** 
  28.      * get all tests. 
  29.      *  
  30.      * @return 
  31.      */  
  32.     @SelectProvider(type = TestSqlProvider.class, method = "getAllSql")  
  33.     @Options(useCache = true, flushCache = false, timeout = 10000)  
  34.     @Results(value = {  
  35.             @Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR),  
  36.             @Result(property = "testText", column = "test_text", javaType = String.class, jdbcType = JdbcType.VARCHAR) })  
  37.     public List<TestBean> getAll();  
  38.   
  39.     /** 
  40.      * get tests by test text. 
  41.      *  
  42.      * @param testText 
  43.      * @return 
  44.      */  
  45.     @SelectProvider(type = TestSqlProvider.class, method = "getByTestTextSql")  
  46.     @Options(useCache = true, flushCache = false, timeout = 10000)  
  47.     @ResultMap(value = "getByTestText")  
  48.     public List<TestBean> getByTestText(@Param("testText") String testText);  
  49.   
  50.     /** 
  51.      * insert a test bean into database. 
  52.      *  
  53.      * @param testBean 
  54.      */  
  55.     @InsertProvider(type = TestSqlProvider.class, method = "insertSql")  
  56.     @Options(flushCache = true, timeout = 20000)  
  57.     public void insert(@Param("testBean") TestBean testBean);  
  58.   
  59.     /** 
  60.      * update a test bean with database. 
  61.      *  
  62.      * @param testBean 
  63.      */  
  64.     @UpdateProvider(type = TestSqlProvider.class, method = "updateSql")  
  65.     @Options(flushCache = true, timeout = 20000)  
  66.     public void update(@Param("testBean") TestBean testBean);  
  67.   
  68.     /** 
  69.      * delete a test by UID. 
  70.      *  
  71.      * @param id 
  72.      */  
  73.     @DeleteProvider(type = TestSqlProvider.class, method = "deleteSql")  
  74.     @Options(flushCache = true, timeout = 20000)  
  75.     public void delete(@Param("id") String id);  
  76. }  

 


下面逐个对里面的注解进行分析: 
@CacheNamespace(size = 512) : 定义在该命名空间内允许使用内置缓存,最大值为512个对象引用,读写默认是开启的,缓存内省刷新时间为默认3600000毫秒,写策略是拷贝整个对象镜 像到全新堆(如同CopyOnWriteList)因此线程安全。 

@SelectProvider(type = TestSqlProvider.class, method = "getSql") : 提供查询的SQL语句,如果你不用这个注解,你也可以直接使用@Select("select * from ....")注解,把查询SQL抽取到一个类里面,方便管理,同时复杂的SQL也容易操作,type = TestSqlProvider.class就是存放SQL语句的类,而method = "getSql"表示get接口方法需要到TestSqlProvider类的getSql方法中获取SQL语句。 

@Options(useCache = true, flushCache = false, timeout = 10000) : 一些查询的选项开关,比如useCache = true表示本次查询结果被缓存以提高下次查询速度,flushCache = false表示下次查询时不刷新缓存,timeout = 10000表示查询结果缓存10000秒。 

@Results(value = { 
@Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR), 
@Result(property = "testText", column = "test_text", javaType = String.class, jdbcType = JdbcType.VARCHAR) }) : 表示sql查询返回的结果集,@Results是以@Result为元素的数组,@Result表示单条属性-字段的映射关系,如:@Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR)可以简写为:@Result(id = true, property = "id", column = "test_id"),id = true表示这个test_id字段是个PK,查询时mybatis会给予必要的优化,应该说数组中所有的@Result组成了单个记录的映射关系,而 @Results则单个记录的集合。另外还有一个非常重要的注解@ResultMap也和@Results差不多,到时会讲到。 

@Param("id") :全局限定别名,定义查询参数在sql语句中的位置不再是顺序下标0,1,2,3....的形式,而是对应名称,该名称就在这里定义。 

@ResultMap(value = "getByTestText") :重要的注解,可以解决复杂的映射关系,包括resultMap嵌套,鉴别器discriminator等等。注意一旦你启用该注解,你将不得不在你的映 射文件中配置你的resultMap,而value = "getByTestText"即为映射文件中的resultMap ID(注意此处的value = "getByTestText",必须是在映射文件中指定命名空间路径)。@ResultMap在某些简单场合可以用@Results代替,但是复杂查 询,比如联合、嵌套查询@ResultMap就会显得解耦方便更容易管理。 
一个映射文件如下所示:

 

  1. <?xml version="1.0" encoding="UTF-8" ?>    
  2. <!DOCTYPE mapper    
  3. PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"    
  4. "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">  
  5.   
  6. <mapper namespace="com.wotao.taotao.persist.test.mapper.TestMapper">  
  7.     <resultMap id="getByTestText" type="TestBean">  
  8.         <id property="id" column="test_id" javaType="string" jdbcType="VARCHAR" />  
  9.         <result property="testText" column="test_text" javaType="string" jdbcType="VARCHAR" />  
  10.     </resultMap>  
  11. </mapper>  

 


注意文件中的namespace路径必须是使用@resultMap的类路径,此处是TestMapper,文件中 id="getByTestText"必须和@resultMap中的value = "getByTestText"保持一致。 

@InsertProvider(type = TestSqlProvider.class, method = "insertSql") :用法和含义@SelectProvider一样,只不过是用来插入数据库而用的。 

@Options(flushCache = true, timeout = 20000) :对于需要更新数据库的操作,需要重新刷新缓存flushCache = true使缓存同步。 

@UpdateProvider(type = TestSqlProvider.class, method = "updateSql") :用法和含义@SelectProvider一样,只不过是用来更新数据库而用的。 

@Param("testBean") :是一个自定义的对象,指定了sql语句中的表现形式,如果要在sql中引用对象里面的属性,只要使用testBean.id,testBean.textText即可,mybatis会通过反射找到这些属性值。 

@DeleteProvider(type = TestSqlProvider.class, method = "deleteSql") :用法和含义@SelectProvider一样,只不过是用来删除数据而用的。 

现 在mybatis注解基本已经讲完了,接下来我们就要开始写SQL语句了,因为我们不再使用映射文件编写SQL,那么就不得不在java类里面写,就像上 面提到的,我们不得不在TestSqlProvider这个类里面写SQL,虽然已经把所有sql语句集中到了一个类里面去管理,但听起来似乎仍然有点恶 心,幸好mybatis提供SelectBuilder和SqlBuilder这2个小工具来帮助我们生成SQL语句,SelectBuilder专门用 来生成select语句,而SqlBuilder则是一般性的工具,可以生成任何SQL语句,我这里选择了SqlBuilder来生 成,TestSqlProvider代码如下:

 

  1. /* 
  2.  * #~ test-afternoon10:51:40  
  3.  */  
  4. package com.wotao.taotao.persist.test.sqlprovider;  
  5.   
  6. import static org.apache.ibatis.jdbc.SqlBuilder.BEGIN;  
  7. import static org.apache.ibatis.jdbc.SqlBuilder.FROM;  
  8. import static org.apache.ibatis.jdbc.SqlBuilder.SELECT;  
  9. import static org.apache.ibatis.jdbc.SqlBuilder.SQL;  
  10. import static org.apache.ibatis.jdbc.SqlBuilder.WHERE;  
  11. import static org.apache.ibatis.jdbc.SqlBuilder.DELETE_FROM;  
  12. import static org.apache.ibatis.jdbc.SqlBuilder.INSERT_INTO;  
  13. import static org.apache.ibatis.jdbc.SqlBuilder.SET;  
  14. import static org.apache.ibatis.jdbc.SqlBuilder.UPDATE;  
  15. import static org.apache.ibatis.jdbc.SqlBuilder.VALUES;  
  16.   
  17. import java.util.Map;  
  18.   
  19. /** 
  20.  * The test sql Provider,define the sql script for mapping. 
  21.  *  
  22.  * @author HuangMin <a href="mailto:minhuang@hengtiansoft.com>send email</a> 
  23.  *  
  24.  * @since 1.6 
  25.  * @version 1.0 
  26.  *  
  27.  *          #~TestSqlProvider.java 2011-9-23 : afternoon 10:51:40 
  28.  */  
  29. public class TestSqlProvider {  
  30.   
  31.     /** table name, here is test */  
  32.     private static final String TABLE_NAME = "test";  
  33.   
  34.     /** 
  35.      * get test by id sql script. 
  36.      *  
  37.      * @param parameters 
  38.      * @return 
  39.      */  
  40.     public String getSql(Map<String, Object> parameters) {  
  41.         String uid = (String) parameters.get("id");  
  42.         BEGIN();  
  43.         SELECT("test_id, test_text");  
  44.         FROM(TABLE_NAME);  
  45.         if (uid != null) {  
  46.             WHERE("test_id = #{id,javaType=string,jdbcType=VARCHAR}");  
  47.         }  
  48.         return SQL();  
  49.     }  
  50.   
  51.     /** 
  52.      * get all tests sql script. 
  53.      *  
  54.      * @return 
  55.      */  
  56.     public String getAllSql() {  
  57.         BEGIN();  
  58.         SELECT("test_id, test_text");  
  59.         FROM(TABLE_NAME);  
  60.         return SQL();  
  61.     }  
  62.   
  63.     /** 
  64.      * get test by test text sql script. 
  65.      *  
  66.      * @param parameters 
  67.      * @return 
  68.      */  
  69.     public String getByTestTextSql(Map<String, Object> parameters) {  
  70.         String tText = (String) parameters.get("testText");  
  71.         BEGIN();  
  72.         SELECT("test_id, test_text");  
  73.         FROM(TABLE_NAME);  
  74.         if (tText != null) {  
  75.             WHERE("test_text like #{testText,javaType=string,jdbcType=VARCHAR}");  
  76.         }  
  77.         return SQL();  
  78.     }  
  79.   
  80.     /** 
  81.      * insert a test sql script. 
  82.      *  
  83.      * @return 
  84.      */  
  85.     public String insertSql() {  
  86.         BEGIN();  
  87.         INSERT_INTO(TABLE_NAME);  
  88.         VALUES("test_id""#{testBean.id,javaType=string,jdbcType=VARCHAR}");  
  89.         VALUES("test_text""#{testBean.testText,javaType=string,jdbcType=VARCHAR}");  
  90.         return SQL();  
  91.     }  
  92.   
  93.     /** 
  94.      * update a test sql script. 
  95.      *  
  96.      * @return 
  97.      */  
  98.     public String updateSql() {  
  99.         BEGIN();  
  100.         UPDATE(TABLE_NAME);  
  101.         SET("test_text = #{testBean.testText,javaType=string,jdbcType=VARCHAR}");  
  102.         WHERE("test_id = #{testBean.id,javaType=string,jdbcType=VARCHAR}");  
  103.         return SQL();  
  104.     }  
  105.   
  106.     /** 
  107.      * delete a test sql script. 
  108.      *  
  109.      * @return 
  110.      */  
  111.     public String deleteSql() {  
  112.         BEGIN();  
  113.         DELETE_FROM(TABLE_NAME);  
  114.         WHERE("test_id = #{id,javaType=string,jdbcType=VARCHAR}");  
  115.         return SQL();  
  116.     }  
  117. }  

 


BEGIN();表示刷新本地线程,某些变量为了线程安全,会先在本地存放变量,此处需要刷新。 
SELECT,FROM,WHERE 等等都是sqlbuilder定义的公用静态方法,用来组成你的sql字符串。如果你在testMapper中调用该方法的某个接口方法已经定义了参数 @Param(),那么该方法的参数Map<String, Object> parameters即组装了@Param()定义的参数,比如testMapper接口方法中定义参数为 @Param("testId"),@Param("testText"),那么parameters的形态就是: [key="testId",value=object1],[key="testText",value=object2],如果接口方法没有定义 @Param(),那么parameters的key就是参数的顺序小标:[key=0,value=object1], [key=1,value=object2],SQL()将返回最终append结束的字符串,sql语句中的形如 
# {id,javaType=string,jdbcType=VARCHAR}完全可简写为#{id},我只是为了规整如此写而已。另外,对于复杂查询还 有很多标签可用,比如:JOIN,INNER_JOIN,GROUP_BY,ORDER_BY等等,具体使用详情,你可以查看源码。 

最后记得把你的Mapper接口注入到你的DAO类中,在DAO中引用Mapper接口方法即可。我在BaseDAO中的注解注入如下:

 

  1. ......  
  2. @Repository("testBaseDAO")  
  3. public class TestBaseDAO {  
  4. ......  

 

 

 

  1. ......  
  2.     /** 
  3.      * @param testMapper 
  4.      *            the testMapper to set 
  5.      */  
  6.     @Autowired  
  7.     public void setTestMapper(@Qualifier("testMapper") TestMapper testMapper) {  
  8.         this.testMapper = testMapper;  
  9.     }  
  10. ......  

 

 

 

引自:http://wwww.iteye.com/blog/1235996

 

 
分享到:
评论

相关推荐

    spring+springmvc+mybatis(CURD)

    本项目"spring+springmvc+mybatis(CURD)"显然旨在通过实践帮助开发者熟悉这三个框架的整合以及基本的数据库CRUD(创建、读取、更新和删除)操作。 首先,Spring框架是一个全面的企业级应用开发框架,它提供了依赖...

    浅谈MyBatis通用Mapper实现原理

    浅谈MyBatis通用Mapper实现原理 MyBatis通用Mapper是MyBatis框架中的一种通用Mapper实现方式,主要提供了一些通用的方法,这些方法是以接口的形式提供的。通用Mapper的实现原理主要是通过Java反射机制和MyBatis框架...

    mybatis通用mapper笔记

    ### MyBatis通用Mapper知识点详解 #### 一、MyBatis通用Mapper简介 MyBatis通用Mapper是一种基于MyBatis框架的扩展插件,它能够为开发者提供一系列方便的CRUD(创建、读取、更新、删除)操作方法,极大地简化了...

    Mybatis通用分页插件

    Mybatis通用分页插件是Java开发中广泛使用的ORM(对象关系映射)框架扩展,主要针对Mybatis进行优化,提供了高效便捷的分页功能。这个插件的目的是简化在数据库查询时的分页操作,使得开发者能够更专注于业务逻辑,...

    mybatis 入门代码示例

    mybatis 入门代码示例

    MyBatis 动态 SQL 示例

    附件是MyBatis 动态 SQL 示例,MyBatis 是一个持久层框架,它允许用户在 XML 文件中编写动态 SQL 语句。MyBatis 的动态 SQL 功能非常强大,它允许开发者根据运行时的条件动态地生成 SQL 语句。这使得 MyBatis 能够...

    MyBatis 动态SQL示例

    附件是MyBatis 动态SQL示例,MyBatis 是一个持久层框架,它允许用户在 XML 文件中编写动态 SQL 语句。MyBatis 的动态 SQL 功能非常强大,它允许开发者根据运行时的条件动态地生成 SQL 语句。这使得 MyBatis 能够灵活...

    Mybatis通用DAO设计封装(mybatis)

    Mybatis通用DAO设计封装主要涉及的是在Java开发中如何高效地使用Mybatis框架进行数据库操作。Mybatis是一款轻量级的持久层框架,它避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。通过提供自定义SQL、存储...

    mybatis简介及示例

    MyBatis 简介及示例 MyBatis 是一个流行的持久层框架,提供了强大的数据库交互能力。MyBatis-Spring 是一个集成 MyBatis 和 Spring 的类库,旨在帮助开发者将 MyBatis 代码无缝地整合到 Spring 中。 MyBatis-...

    mybatis通用MapperUUID简单示例共3页.pd

    MyBatis通用Mapper是MyBatis框架的一个扩展,它极大地简化了常见的CRUD操作,使得开发者无需编写大量的SQL映射代码。在本示例中,我们聚焦于如何使用通用Mapper处理UUID类型的主键,以此来增强数据库操作的灵活性...

    mybatis查询简单示例

    在本示例中,我们将探讨如何使用MyBatis进行简单的数据查询,包括分页功能,以及与前端EasyUI框架的集成。让我们逐一解析这些知识点。 1. **MyBatis简介**:MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取...

    springmybatis(含有mybatis-generator示例)

    在本项目"springmybatis(含有mybatis-generator示例)"中,主要展示了如何将Spring、Spring Web MVC和MyBatis框架进行集成,并且利用MyBatis Generator自动化工具生成数据库操作的代码,使得开发过程更为高效。...

    TkMybatis通用Mapper逆向工程代码生成工具

    TkMybatis通用Mapper逆向工程代码生成工具是Java开发中的一个高效实用的工具,它基于Maven项目构建,主要用于简化数据库表与Java实体类、Mapper接口及XML映射文件之间的同步工作。通过此工具,开发者可以自动生成...

    MyBatis 通用 Mapper 实现原理及相关内容 - GitChat

    MyBatis 通用 Mapper 实现原理及相关内容 抓下来打包成了HTML文件, 方便离线观看

    springboot+springmvc+mybatis+mysql示例项目

    综上所述,这个"springboot+springmvc+mybatis+mysql示例项目"为初学者和开发者提供了一个完整的、实战性的学习平台,涵盖了现代Java Web开发的核心技术,有助于快速理解和实践Spring全家桶与数据库的集成应用。...

    servlet3.0与mybatis整合的示例

    四、实战示例 在servlet3mybatis压缩包中,可能包含了以下文件: - web.xml:虽然Servlet3.0支持注解配置,但可能还是包含了一个简单的web.xml用于部署描述。 - mybatis-config.xml:MyBatis的核心配置文件。 - ...

    mybatis基于配置示例

    标题 "mybatis基于配置示例" 指的是一个关于MyBatis框架的实际操作教程,主要探讨如何在项目中配置并使用MyBatis。MyBatis是一个优秀的持久层框架,它支持定制化SQL、存储过程以及高级映射。通过XML或注解方式,...

    Mybatis通用增删改查

    在实际开发中,为了提高代码的复用性和减少重复工作,开发者通常会实现一套通用的增删改查模板,这就是“Mybatis通用增删改查”的概念。 1. **基础 DaoImpl 概念** Dao(Data Access Object)接口是Java中用于...

    SpringMVC+Spring+myBatis框架整合示例代码.zip

    【标题】"SpringMVC+Spring+myBatis框架整合示例代码.zip"是一个压缩包,其中包含了关于如何集成和使用SpringMVC、Spring和MyBatis三个流行Java Web开发框架的实例代码。这个整合旨在提供一个高效、灵活且可维护的...

Global site tag (gtag.js) - Google Analytics