mybatis参数映射

灰太狼 2022-06-17 02:39 266阅读 0赞

mybatis参数映射(?)

### 规则 ###

1.  非`@Param`注解参数时可使用
    
        #{参数位置[0..n-1]}
    
    或者
    
        #{param[1..n]}
    
    如果参数类型是自定义对象(bean)时,只需加上`.对象属性`即可
    
        #{参数位置[0..n-1].对象属性}
              #{param[1..n].对象属性}
    
    特别的，如果非注解参数只有一个时，可使用
    
        #{任意字符}
    
    来访问参数
2.  `@Param`的作用是设置参数别名。设置后的参数只能通过
    
        #{注解别名}
    
    或者
    
        #{param[1..n]}
    
    如果参数类型是自定义对象(bean)时,只需加上`.对象属性`即可
    
        #{注解别名.属性}
              #{param[1..n].属性}
    
    来访问参数

### 示例 ###

为了明确上述规则，我们的示例具体细分了各种情况进行展示。

#### 非注解型 ####

##### 一个参数  **\[java\]**  [view plain][]   [copy][view plain]    [print][view plain] [?][view plain]  <span style="font-weight: normal;"><span style="font-family:Microsoft YaHei;font-size:14px;">User getUserById(int id);        select \* from <TABLE> where id = \#\{id\}    // or    select \* from <TABLE> where id = \#\{abdc\}    // or    select \* from <TABLE> where id = \#\{param1\}        User getUser(User user); // user.getName user.getAge         select \* from <TABLE> where name = \#\{name\} and age = \#\{age\}</span></span>        #####

##### 多个参数  **\[java\]**  [view plain][]   [copy][view plain]    [print][view plain] [?][view plain]  <span style="font-family:Microsoft YaHei;font-size:14px;">User getUser(String name, int age);          select \* from <TABLE> where name = \#\{ 0\} and age = \#\{ 1\}      // or      select \* from <TABLE> where name = \#\{param1\} and age = \#\{param2\}          User getUser(User usr, int flag);          select \* from <TABLE> where name = \#\{ 0.name\} and age = \{ 0.age\} and flag = \#\{ 1\}      // or      select \* from <TABLE> where name = \#\{param1.name\} and age = \{param1.age\} and flag = \#\{param2\}</span>        #####

#### 注解型 ####

##### 一个参数  **\[java\]**  [view plain][]   [copy][view plain]    [print][view plain] [?][view plain]  <span style="font-family:Microsoft YaHei;font-size:14px;">User getUserById(@Param(value="keyId") int id);          select \* from <TABEL> where id = \#\{keyId\}      // or      select \* from <TABLE> where id = \#\{param1\}          User getUser(@Param(value="user") User user); // user.getName user.getAge          select \* from <TABLE> where name = \#\{user.name\} and age = \#\{user.age\}      // or      select \* from <TABLE> where name = \#\{param1.name\} and age = \#\{param1.age\}</span>        #####

##### 多个参数  **\[java\]**  [view plain][]   [copy][view plain]    [print][view plain] [?][view plain]  <span style="font-family:Microsoft YaHei;font-size:14px;">User getUser(@Param(value="xm") String name, @Param(value="nl") int age);          select \* from <TABLE> where name = \#\{xm\} and age = \#\{nl\}      // or      select \* from <TABLE> where name = \#\{param1\} and age = \#\{param2\}      // or      select \* from <TABLE> where name = \#\{xm\} and age = \#\{param2\}          User getUser(@Param(value="usr") User user, @Param(value="tag") int flag);         select \* from <TABLE> where name = \#\{usr.name\} and age = \#\{usr.age\} and flag = \#\{tag\}      // or      select \* from <TABLE> where name = \#\{param1.name\} and age = \#\{param1.age\} and flag = \#\{param2\}      // or      select \* from <TABLE> where name = \#\{usr.name\} and age = \#\{param1.age\} and flag = \#\{param2\}</span>        #####

#### 非注解和注解型混合型 ####

当采用部分参数使用`@Param`注解时，参数注释为将以上两种情况结合起来即可.

**\[java\]**  [view plain][]   [copy][view plain]

[print][view plain] [?][view plain]

1.  <span style="font-family:Microsoft YaHei;font-size:14px;">User getUser(String name, @Param(value="nl") age, **int** gendar);    
2.    
3.  // 对于age的访问不能是 \#\{1\} 只能是 \#\{param2\} | \#\{nl\}    
4.  select \* from <TABLE> where name = \#\{ 0\} and age = \#\{nl\} and gendar = \#\{param3)</span>

### 框架主要映射处理代码 ###

#### 参数的获取 ####

**\[java\]**  [view plain][]   [copy][view plain]

[print][view plain] [?][view plain]

1.  <span style="font-family:Microsoft YaHei;font-size:14px;">org.apache.ibatis.binding.MapperMethod  
2.  **private** Object getParam(Object\[\] args) \{    
3.      **final** **int** paramCount = paramPositions.size();    
4.      // 无参数    
5.      **if** (args == **null** || paramCount == 0) \{    
6.          **return** **null**;    
7.      // 无注解并参数个数为1    
8.      \} **else** **if** (!hasNamedParameters && paramCount == 1) \{    
9.          **return** args\[paramPositions.get(0)\];    
10.     \} **else** \{    
11.         Map<String, Object> param = **new** MapperParamMap<Object>();    
12.         **for** (**int** i = 0; i < paramCount; i++) \{    
13.             param.put(paramNames.get(i), args\[paramPositions.get(i)\]);    
14.     \}    
15.     // issue \#71, add param names as param1, param2...but ensure backward compatibility    
16.     // 这就是 \#\{param\[1..n\]\} 的来源    
17.     **for** (**int** i = 0; i < paramCount; i++) \{    
18.         String genericParamName = "param" + String.valueOf(i + 1);    
19.         **if** (!param.containsKey(genericParamName)) \{    
20.             param.put(genericParamName, args\[paramPositions.get(i)\]);    
21.         \}    
22.     \}    
23.     **return** param;    
24.     \}    
25. \}</span>

#### SQL预编译参数设置 ####

**\[java\]**  [view plain][]   [copy][view plain]

[print][view plain] [?][view plain]

1.  <span style="font-family:Microsoft YaHei;font-size:14px;">org.apache.ibatis.executor.parameter.DefaultParameterHandler  
2.  **public** **void** setParameters(PreparedStatement ps) **throws** SQLException \{    
3.      ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());    
4.      List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();    
5.      **if** (parameterMappings != **null**) \{    
6.          MetaObject metaObject = parameterObject == **null** ? **null** : configuration.newMetaObject(parameterObject);    
7.          **for** (**int** i = 0; i < parameterMappings.size(); i++) \{    
8.              ParameterMapping parameterMapping = parameterMappings.get(i);    
9.              **if** (parameterMapping.getMode() != ParameterMode.OUT) \{    
10.                 Object value;    
11.                 String propertyName = parameterMapping.getProperty();    
12.                 PropertyTokenizer prop = **new** PropertyTokenizer(propertyName);    
13.                 **if** (parameterObject == **null**) \{    
14.                     value = **null**;    
15.                 \} **else** **if** (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) \{    
16.                     value = parameterObject;    
17.                 \} **else** **if** (boundSql.hasAdditionalParameter(propertyName)) \{    
18.                     value = boundSql.getAdditionalParameter(propertyName);    
19.                 \} **else** **if** (propertyName.startsWith(ForEachSqlNode.ITEM\_PREFIX)    
20.           && boundSql.hasAdditionalParameter(prop.getName())) \{    
21.                     value = boundSql.getAdditionalParameter(prop.getName());    
22.                     **if** (value != **null**) \{    
23.                         value = configuration.newMetaObject(value).getValue(propertyName.substring(prop.getName().length()));    
24.                     \}    
25.             \} **else** \{    
26.                 value = metaObject == **null** ? **null** : metaObject.getValue(propertyName);    
27.             \}    
28.             TypeHandler typeHandler = parameterMapping.getTypeHandler();    
29.             **if** (typeHandler == **null**) \{    
30.                 **throw** **new** ExecutorException("There was no TypeHandler found for parameter " + propertyName + " of statement " + mappedStatement.getId());    
31.             \}    
32.             JdbcType jdbcType = parameterMapping.getJdbcType();    
33.             **if** (value == **null** && jdbcType == **null**) jdbcType = configuration.getJdbcTypeForNull();    
34.                 typeHandler.setParameter(ps, i + 1, value, jdbcType);    
35.             \}    
36.         \}    
37.     \}    
38. \}</span>

[view plain]: http://blog.csdn.net/wangli61289/article/details/9967383#