天天看點

Mybatis介紹之參數傳遞 9       Mybatis介紹之參數傳遞

       Mybatis在使用Mapper接口進行程式設計時,其實底層是采用了動态代理機制,表面上是調用的Mapper接口,而實際上是通過動态代理調用的SqlSession的對應方法,如selectOne(),有興趣的朋友可以檢視DefaultSqlSession的getMapper()方法實作,其最終會獲得一個代理了Mapper接口的MapperProxy對象。MapperProxy對象在調用Mapper接口方法時會把傳遞的參數做一個轉換,然後把轉換後的參數作為入參調用SqlSession對應的操作方法(如selectOne、insert等)。轉換過程可以參考MapperMethod的execute()方法實作。簡單來說是以下規則:

1、如果傳遞過來是單參數,且沒有以@Param注解進行命名,則直接将單參數作為真實的參數調用SqlSession的對應方法。

2、如果傳遞過來的不是單參數或者是包含以@Param注解進行命名的參數,則會将對應的參數轉換為一個Map進行傳遞。具體規則如下:

2.1、      會把對應的參數按照順序以param1、param2、paramN這樣的形式作為Key存入目标Map中,第一個參數是param1,第N個參數是paramN。

2.2、      如果參數是以@Param注解命名的參數,則以@Param指定的名稱作為Key存入目标Map中。

2.3、      如果參數不是以@Param注解命名的,則按照順序以0、1、N這樣的形式作為Key存入目标Map中,第一個參數是0,第N個參數是N。

       我們在Mapper.xml中定義SQL語句中用到的變量最終是以Mybatis按照上述規則把入參轉換後的形式來進行解析的。

       在Mybatis的Mapper.xml檔案中為了建構動态的SQL,我們通常需要通過引用傳遞的參數來達到對應的效果。在引用傳遞的參數的時候有兩種方式,一種是通過“#{var}”的形式引用,一種是通過“${var}”的形式引用。前者會被以預編譯的方式傳遞,即會生成PreparedStatement來處理,對應的參數在SQL中會以“?”占位,然後調用PreparedStatement的相應API設值;而後者則會先處理好變量再執行相應的SQL,即對應的變量會先被替換,再執行替換了變量的SQL。在一個Mapper映射語句中我們可以同時使用“#”和“$”處理變量。

       采用#{var}的形式來引用變量時,其中的變量會在解析Mapper.xml檔案中的語句時就被替換為占位符“?”,同時通過ParameterMapping類記錄對應的變量資訊。在真正執行對應的語句時會用傳遞的真實參數根據ParameterMapping資訊給PreparedStatement設定參數,具體可參考PreparedStatementHandler的parameterize()方法實作。對應的變量在解析的時候都是以傳遞進來的參數為基礎來解析的,根據前面的介紹我們知道,傳遞進來的參數隻有兩種情況,一種是原始類型的單參數,一種是被Mybatis封裝過的Map。那對應的參數Mybatis的如何解析的呢?有三種情況。

       第一種,如果真實傳遞進來的是原始類型,那麼對應的屬性解析就是就是基于原始類型的屬性。比如我們真是傳遞進來的一個User類型的對象,User對象有id、name等屬性,那麼我們在Mapper語句中采用#{var}形式通路變量的時候就可以使用#{id}和#{name}。這跟使用${var}形式通路變量是不同的,使用${var}形式時我們需要使用${_parameter.id}和${_parameter.name}。

   <insert id="insert" parameterType="com.elim.learn.mybatis.model.User" useGeneratedKeys="true" keyColumn="id" keyProperty="id">

      insert into t_user(name,username,email,mobile) values(#{name},#{username},#{email},#{mobile})

   </insert>

       第二種,如果真實傳遞進來的是一個Map,那麼對應的變量則可以是這個Map裡面的Key。比如下面示例中我們的接口方法對應的是兩個參數,那最終到執行Mapper語句時會被封裝成一個Map,Map裡面的Key包含name、1、param1和param2,那麼我們在使用的時候就可以使用這些變量。

   List<User> findByNameAndMobile(@Param("name") String name, String mobile);

   <select id="findByNameAndMobile" resultType="com.elim.learn.mybatis.model.User">

      select id,name,username,email,mobile from t_user where name=#{name} and mobile=#{1}

   </select>

       第三種,真實傳遞進來的參數是可以被已經注冊了的TypeHandler進行處理的,則直接使用真實傳遞進來的參數作為真實的變量值。這也是為什麼我們經常可以在Mapper接口裡面寫delete(Integer id),然後在Mapper語句中直接寫#{id}的原因,因為這個時候傳遞進來的參數是Integer類型,是可以直接被處理的,Mybatis将直接拿它的值作為目前變量id的值,而不會去取傳遞進來的值的id屬性。換句話說,這個時候我們在Mapper語句中定義的變量可以随便命名,随便怎麼命名都可以被Mybatis正确的處理。但是通常我們會把它命名為與接口方法參數名稱一緻,友善閱讀。

   void delete(Long id);

   <insert id="delete" parameterType="java.lang.Long">

      delete t_user where id=#{id}

       關于預編譯的參數處理是由DefaultParameterHandler類的setParameters()方法處理,核心代碼如下,欲了解更多,可以參考DefaultParameterHandler的完整代碼。

  public void setParameters(PreparedStatement ps) {

    ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());

    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();

    if (parameterMappings != null) {

      for (inti = 0; i < parameterMappings.size(); i++) {

        ParameterMapping parameterMapping = parameterMappings.get(i);

        if (parameterMapping.getMode() != ParameterMode.OUT) {

          Object value;

          String propertyName = parameterMapping.getProperty();

          if (boundSql.hasAdditionalParameter(propertyName)) { // issue #448 ask first for additional params

            value = boundSql.getAdditionalParameter(propertyName);

          } else if (parameterObject == null) {

            value = null;

          } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {

            value = parameterObject;

          } else {

            MetaObject metaObject = configuration.newMetaObject(parameterObject);

            value = metaObject.getValue(propertyName);

          }

          TypeHandler typeHandler = parameterMapping.getTypeHandler();

          JdbcType jdbcType = parameterMapping.getJdbcType();

          if (value == null && jdbcType == null) {

            jdbcType = configuration.getJdbcTypeForNull();

          try {

            typeHandler.setParameter(ps, i + 1, value, jdbcType);

          } catch (TypeException e) {

            throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);

          } catch (SQLException e) {

        }

      }

    }

  }

       采用“${var}”的形式來引用變量時,其中的變量會在MappedStatement調用getBoundSql()方法擷取對應的BoundSql時被替換。${var}中的var可以是如下取值:

1、内置的_parameter變量,對應轉換後的傳遞參數,在隻傳遞單參數且是沒有使用@Param注解對參數命名的時候如果我們需要通過${var}的形式來通路傳遞的單參數,則可以使用${_parameter};

2、如果對應的Mapper接口方法是多參數或者擁有@Param命名的參數時可以使用param1、paramN的形式;

3、如果對應的Mapper接口方法參數是@Param命名的方法參數,則可以使用@Param指定的名稱;

4、如果對應的Mapper接口方法擁有多個參數,且擁有沒有使用@Param命名的參數,那沒有使用@Param命名的參數可以通過0、1、N形式通路。

       根據上述規則如我們有一個findById的方法其接收一個Long類型的參數作為ID,當使用${var}的形式引用變量時則可以寫成如下這樣:

   <select id="findById" resultType="com.elim.learn.mybatis.model.User" parameterType="java.lang.Long" >

      select id,name,username,email,mobile from t_user where id=${_parameter}

       當我們的Mapper接口方法參數使用了@Param命名的時候,我們還可以使用@Param指定的參數名。

public interface UserMapper {

   User findById(@Param("id") Long id);

}

      select id,name,username,email,mobile from t_user where id=${id}

       注意,但是使用了@Param對單參數命名後我們就不能再在Mapper語句中通過${_parameter}來引用接口方法參數傳遞過來的單參數了,因為此時其已經被包裝為一個Map了,如果要通過_parameter來引用的話,我們應該使用${_parameter.param1}或${_parameter.varName},對于上面的示例來說就是${_parameter.param1}或${_parameter.id}。

       下面我們來看一個傳遞多參數的,假設我們有如下這樣的一個Mapper語句及對應的Mapper接口方法,這個Mapper接口方法接收兩個參數,第一個參數是用@Param注解指定了參數名為name,第二個參數是沒有使用注解的,具體如下。

   <!-- 當對應的接口方法傳遞多個參數時,可以不指定parameterType參數,就算指定了也沒用,因為這個時候預設是Map -->

      select id,name,username,email,mobile from t_user where name='${name}' and mobile='${1}'

     那我們的Mapper.xml檔案中的對應語句需要Mapper接口方法參數時有哪幾種方式呢?按照之前的規則,對于第一個方法參數name而言,因為使用了@Param指定了參數名name,是以我們可以在Mapper.xml檔案中通過變量name和param1來引用它,而第二個參數mobile是沒有使用@Param指定參數名的,則我們可以使用param2和參數相對位置“1”來引用它。如上面的示例中,我們就是通過第二個參數的相對位置“1”來引用的。如果我們把第二個參數改為${mobile}是引用不到,且系統會報如下錯誤,有興趣的朋友可以試一下。

org.apache.ibatis.binding.BindingException: Parameter 'mobile' not found. Available parameters are [1, name, param1, param2]

       一般情況下為了防止SQL注入問題,是不建議直接在where條件中使用${var}的形式通路變量的,通常會用預編譯形式的#{var}。而${var}往往是用來傳遞一些非where條件的内容,比如排序資訊,具體用法請根據實際情況決定。

org.apache.ibatis.session.defaults.DefaultSqlSession源碼

org.apache.ibatis.binding.MapperMethod源碼

org.apache.ibatis.executor.statement.PreparedStatementHandler源碼

org.apache.ibatis.scripting.defaults.DefaultParameterHandler源碼

(注:本文是基于Mybatis3.3.1所寫,寫于2016年12月22日星期四)