mybatis注解實現CURD

我們來看下面這段代碼：

/** 
 * The user Mapper interface. 
 *  
 * @author Wangzun
 *
 * @version 1.0 
 *  
 *
 */  
@CacheNamespace(size = 512)  
public interface UserMapper {  
  
    /** 
     * get user bean by id. 
     *  
     * @param id 
     * @return 
     */  
    @SelectProvider(type = UserSqlProvider.class, method = "getSql")  
    @Options(useCache = true, flushCache = false, timeout = 10000)  
    @Results(value = {  
            @Result(id = true, property = "id", column = "user_id", javaType = String.class, jdbcType = JdbcType.VARCHAR),  
            @Result(property = "userName", column = "user_name", javaType = String.class, jdbcType = JdbcType.VARCHAR) })  
    public UserBean get(@Param("id") String id);  
  
    /** 
     * get all users. 
     *  
     * @return 
     */  
    @SelectProvider(type = UserSqlProvider.class, method = "getAllSql")  
    @Options(useCache = true, flushCache = false, timeout = 10000)  
    @Results(value = {  
            @Result(id = true, property = "id", column = "user_id", javaType = String.class, jdbcType = JdbcType.VARCHAR),  
            @Result(property = "userName", column = "user_name", javaType = String.class, jdbcType = JdbcType.VARCHAR) })  
    public List<UserBean> getAll();  
  
    /** 
     * get users by test userName. 
     *  
     * @param userName
     * @return 
     */  
    @SelectProvider(type = UserSqlProvider.class, method = "getByUserNameSql")  
    @Options(useCache = true, flushCache = false, timeout = 10000)  
    @ResultMap(value = "getByUserName")  
    public List<TestBean> getByUserName(@Param("userName") String userName);  
  
    /** 
     * insert a user bean into database. 
     *  
     * @param userBean
     */  
    @InsertProvider(type = UserSqlProvider.class, method = "insertSql")  
    @Options(flushCache = true, timeout = 20000)  
    public void insert(@Param("userBean") UserBean userBean);  
  
    /** 
     * update a user bean with database. 
     *  
     * @param userBean
     */  
    @UpdateProvider(type = UserSqlProvider.class, method = "updateSql")  
    @Options(flushCache = true, timeout = 20000)  
    public void update(@Param("userBean") UserBean usertBean);  
  
    /** 
     * delete a user by id. 
     *  
     * @param id 
     */  
    @DeleteProvider(type = UserSqlProvider.class, method = "deleteSql")  
    @Options(flushCache = true, timeout = 20000)  
    public void delete(@Param("id") String id);  
} 

@CacheNamespace(size = 512) ： 定義在該命名空間內允許使用內置緩存，最大值為512個對象引用，讀寫默認是開啟的，緩存內省刷新時間為默認3600000毫秒，寫策略是拷貝整個對象鏡像到全新堆（如同CopyOnWriteList）因此線程安全。 

@SelectProvider(type = UserSqlProvider.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 = "user_id", javaType = String.class, jdbcType = JdbcType.VARCHAR), 
@Result(property = "userName", column = "user_name", javaType = String.class, jdbcType = JdbcType.VARCHAR) }) ： 表示sql查詢返回的結果集，@Results是以@Result為元素的數組，@Result表示單條屬性-字段的映射關系，如：@Result(id = true, property = "id", column = "user_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 = "getByUserName") ：重要的注解，可以解決復雜的映射關系，包括resultMap嵌套，鑒別器discriminator等等。注意一旦你啟用該注解，你將不得不在你的映射文件中配置你的resultMap，而value = "getByUserName"即為映射文件中的resultMap ID(注意此處的value = "getByUserName"，必須是在映射文件中指定命名空間路徑)。@ResultMap在某些簡單場合可以用@Results代替，但是復雜查詢，比如聯合、嵌套查詢@ResultMap就會顯得解耦方便更容易管理。

一個映射文件如下所示：

<?xml version="1.0" encoding="UTF-8" ?>    
<!DOCTYPE mapper    
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"    
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">  
  
<mapper namespace="com.persist.user.mapper.UserMapper">  
    <resultMap id="getByUserName" type="UserBean">  
        <id property="id" column="test_id" javaType="string" jdbcType="VARCHAR" />  
        <result property="userName" column="user_name" javaType="string" jdbcType="VARCHAR" />  
    </resultMap>  
</mapper>  

注意文件中的namespace路徑必須是使用@resultMap的類路徑，此處是UserMapper，文件中 id="getByUserName"必須和@resultMap中的value = "getByUserName"保持一致。 

@InsertProvider(type = UserSqlProvider.class, method = "insertSql") ：用法和含義@SelectProvider一樣，只不過是用來插入數據庫而用的。 

@Options(flushCache = true, timeout = 20000) ：對於需要更新數據庫的操作，需要重新刷新緩存flushCache = true使緩存同步。 

@UpdateProvider(type = UserSqlProvider.class, method = "updateSql") ：用法和含義@SelectProvider一樣，只不過是用來更新數據庫而用的。 

@Param("userBean") ：是一個自定義的對象，指定了sql語句中的表現形式，如果要在sql中引用對象里面的屬性，只要使用userBean.id，userBean.userName即可，mybatis會通過反射找到這些屬性值。 

@DeleteProvider(type =UserSqlProvider.class, method = "deleteSql") ：用法和含義@SelectProvider一樣，只不過是用來刪除數據而用的。 

現在mybatis注解基本已經講完了，接下來我們就要開始寫SQL語句了，因為我們不再使用映射文件編寫SQL，那么就不得不在java類里面寫，就像上面提到的，我們不得不在UserSqlProvider這個類里面寫SQL，雖然已經把所有sql語句集中到了一個類里面去管理，但聽起來似乎仍然有點惡心，幸好mybatis提供SelectBuilder和SqlBuilder這2個小工具來幫助我們生成SQL語句，SelectBuilder專門用來生成select語句，而SqlBuilder則是一般性的工具，可以生成任何SQL語句，我這里選擇了SqlBuilder來生成，TestSqlProvider代碼如下：

/* 
 *
 */  
package com.persist.user.sqlprovider;  
  
import static org.apache.ibatis.jdbc.SqlBuilder.BEGIN;  
import static org.apache.ibatis.jdbc.SqlBuilder.FROM;  
import static org.apache.ibatis.jdbc.SqlBuilder.SELECT;  
import static org.apache.ibatis.jdbc.SqlBuilder.SQL;  
import static org.apache.ibatis.jdbc.SqlBuilder.WHERE;  
import static org.apache.ibatis.jdbc.SqlBuilder.DELETE_FROM;  
import static org.apache.ibatis.jdbc.SqlBuilder.INSERT_INTO;  
import static org.apache.ibatis.jdbc.SqlBuilder.SET;  
import static org.apache.ibatis.jdbc.SqlBuilder.UPDATE;  
import static org.apache.ibatis.jdbc.SqlBuilder.VALUES;  
  
import java.util.Map;  
  
/** 
 * The test sql Provider,define the sql script for mapping. 
 *  
 * @author Wangzun
 *  
 *   
 */  
public class UserSqlProvider {  
  
    /** table name, here is user */  
    private static final String TABLE_NAME = "user";  
  
    /** 
     * get user by id sql script. 
     *  
     * @param parameters 
     * @return 
     */  
    public String getSql(Map<String, Object> parameters) {  
        String uid = (String) parameters.get("id");  
        BEGIN();  
        SELECT("user_id, user_name");  
        FROM(TABLE_NAME);  
        if (uid != null) {  
            WHERE("user_id= #{id,javaType=string,jdbcType=VARCHAR}");  
        }  
        return SQL();  
    }  
  
    /** 
     * get all users sql script. 
     *  
     * @return 
     */  
    public String getAllSql() {  
        BEGIN();  
        SELECT("user_id, user_name");  
        FROM(TABLE_NAME);  
        return SQL();  
    }  
  
    /** 
     * get test by userName sql script. 
     *  
     * @param parameters 
     * @return 
     */  
    public String getByUserNameSql(Map<String, Object> parameters) {  
        String tText = (String) parameters.get("userName");  
        BEGIN();  
        SELECT("user_id, user_name");  
        FROM(TABLE_NAME);  
        if (tText != null) {  
            WHERE("user_name like #{userName,javaType=string,jdbcType=VARCHAR}");  
        }  
        return SQL();  
    }  
  
    /** 
     * insert a user sql script. 
     *  
     * @return 
     */  
    public String insertSql() {  
        BEGIN();  
        INSERT_INTO(TABLE_NAME);  
        VALUES("user_id", "#{userBean.id,javaType=string,jdbcType=VARCHAR}");  
        VALUES("user_name", "#{userBean.userName,javaType=string,jdbcType=VARCHAR}");  
        return SQL();  
    }  
  
    /** 
     * update a user sql script. 
     *  
     * @return 
     */  
    public String updateSql() {  
        BEGIN();  
        UPDATE(TABLE_NAME);  
        SET("user_name= #{userBean.userName,javaType=string,jdbcType=VARCHAR}");  
        WHERE("user_id= #{userBean.id,javaType=string,jdbcType=VARCHAR}");  
        return SQL();  
    }  
  
    /** 
     * delete a user sql script. 
     *  
     * @return 
     */  
    public String deleteSql() {  
        BEGIN();  
        DELETE_FROM(TABLE_NAME);  
        WHERE("user_id= #{id,javaType=string,jdbcType=VARCHAR}");  
        return SQL();  
    }  
}  

BEGIN();表示刷新本地線程，某些變量為了線程安全，會先在本地存放變量，此處需要刷新。 
SELECT，FROM，WHERE等等都是sqlbuilder定義的公用靜態方法，用來組成你的sql字符串。如果你在userMapper中調用該方法的某個接口方法已經定義了參數@Param()，那么該方法的參數Map<String, Object> parameters即組裝了@Param()定義的參數，比如userMapper接口方法中定義參數為@Param("userId"),@Param("userText")，那么parameters的形態就是：[key="userId",value=object1],[key="userText",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中的注解注入如下

@Repository("userBaseDAO")  
public class UserBaseDAO { 
........
}

 @Autowired  
    public void setUserMapper(@Qualifier("userMapper")UserMapper userMapper) {  
        this.userMapper =userMapper;  
    }  

本文參考：http://www.cnblogs.com/ibook360/archive/2012/07/16/2594056.html