QA 由浅入深持久层框架（四） - SQL Mapping XML（中）

「这是我参与2022首次更文挑战的第22天，活动详情查看：2022首次更文挑战」

一、select

查询语句是 MyBatis 中最常用的元素之一——仅把数据存到数据库中价值并不大，还要能重新取出来才有用，多数应用也都是查询比修改要频繁。 MyBatis 的基本原则之一是：在每个插入、更新或删除操作之间，通常会执行多个查询操作。因此，MyBatis 在查询和结果映射做了相当多的改进。一个简单查询的 select 元素是非常简单的。select 元素允许你配置很多属性来配置每条语句的行为细节。

属性	描述
id	在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType	将会传入这条语句的参数的类全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过类型处理器（TypeHandler）推断出具体传入语句的参数，默认值为未设置（unset）。
parameterMap	用于引用外部 parameterMap 的属性，目前已被废弃。请使用行内参数映射和 parameterType 属性。
resultType	期望从这条语句中返回结果的类全限定名或别名。 注意，如果返回的是集合，那应该设置为集合包含的类型，而不是集合本身的类型。 resultType 和 resultMap 之间只能同时使用一个。
resultMap	对外部 resultMap 的命名引用。结果映射是 MyBatis 最强大的特性，如果你对其理解透彻，许多复杂的映射问题都能迎刃而解。 resultType 和 resultMap 之间只能同时使用一个。
flushCache	将其设置为 true 后，只要语句被调用，都会导致本地缓存和二级缓存被清空，默认值：false。
useCache	将其设置为 true 后，将会导致本条语句的结果被二级缓存缓存起来，默认值：对 select 元素为 true。
timeout	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为未设置（unset）（依赖数据库驱动）。
fetchSize	这是一个给驱动的建议值，尝试让驱动程序每次批量返回的结果行数等于这个设置值。 默认值为未设置（unset）（依赖驱动）。
statementType	可选 STATEMENT，PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
resultSetType	FORWARD_ONLY，SCROLL_SENSITIVE, SCROLL_INSENSITIVE 或 DEFAULT（等价于 unset） 中的一个，默认值为 unset （依赖数据库驱动）。
databaseId	如果配置了数据库厂商标识（databaseIdProvider），MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句；如果带和不带的语句都有，则不带的会被忽略。
resultOrdered	这个设置仅针对嵌套结果 select 语句：如果为 true，将会假设包含了嵌套结果集或是分组，当返回一个主结果行时，就不会产生对前面结果集的引用。 这就使得在获取嵌套结果集的时候不至于内存不够用。默认值：false。
resultSets	这个设置仅适用于多结果集的情况。它将列出语句执行后返回的结果集并赋予每个结果集一个名称，多个名称之间以逗号分隔。

参数传递

查询语句中根据查询条件的不同可能会传入一个参数或者多个参数，如何获取这些传递的参数？

参数传递有四种情况

• 单个参数：可以接受基本类型、对象类型、集合类型的值；只有一个参数情况下MyBatis可以直接使用这个参数，不需要经过任何处理。
• 多个参数：任意多个参数会被MyBatis重新包装成一个Map传入，Map的key为param1、param2、0、1，Map的value就是参数的值，可以通过key来获取参数的值
• 命名参数：使用@Param注解为参数起一个名字，MyBatis就会将这些参数封装到Map时使用指定的名字
• POJO：当参数属于业务POJO时，直接传递POJO
• Map：也可以将多个参数封装为Map，直接传递Map

传递多个参数

在EmployeeDao接口中新增一个查询方法

Employee getEmpByIdAndEmpName(Integer id, String empName);
复制代码

employee.xml中增加SQL映射

<select id="getEmpByIdAndEmpName" resultType="com.citi.entity.Employee">
    select * from t_employee where id = #{id} and empname = #{empName}
</select>
复制代码

执行测试方法

修改SQL语句

<select id="getEmpByIdAndEmpName" resultType="com.citi.entity.Employee">
    select * from t_employee where id = #{param1} and empname = #{param2}
</select>
复制代码

再次执行测试

只传一个参数的时候，如getEmpById方法，传入参数的名称可以是任意的

<select id="getEmpById" resultType="com.citi.entity.Employee">
    select * from t_employee where id = #{mybatis}
</select>
复制代码

执行测试

就传入一个参数，写啥名都能取到

传入多个参数时，使用#{参数名}是无效的，可以使用0、1或者param1、param2来代替，这是因为只要传入了多个参数，MyBatis就会自动将这些参数封到Map中，封装时使用的Map的可以就是参数的索引，#{key}就是传入的参数值

可以使用@Param注解指定封装到Map中的Key。修改方法定义，指定MyBatis封装的key的名称

Employee getEmpByIdAndEmpName(@Param("id") Integer id, @Param("name") String empName);
复制代码

SQL映射文件中使用#{参数名}取值，执行测试

传入Map

在EmoloyeeDao接口中新增一个方法

Employee getEmployeeByIdAndName(Map<String,Object> paramMap);
复制代码

增加SQL映射语句

<select id="getEmployeeByIdAndName" resultType="com.citi.entity.Employee">
    select * from t_employee where id = #{id} and empname = #{name}
</select>
复制代码

增加测试方法

@Test
public void getEmployeeByIdAndName(){

    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    Map<String, Object> paramMap = new HashMap<>();
    paramMap.put("id",1);
    paramMap.put("name","stark");
    Employee employee = employeeDao.getEmployeeByIdAndName(paramMap);

    System.out.println(employee);
}
复制代码

执行测试

当参数传入Map时，可以使用#{Key}来获取参数的Value。

当一个方法中集合了以上所有情况，即多个参数的情况

getByIdAndNameAndEmployee(@Param("id) id, String empName, Employee employee);
复制代码

id使用#{id}取值，empName使用#{param2}取值，使用#{param3.email}可以取出Employee中的email信息

参数处理

SQL映射文件中SQL语句参数位置支持的属性有javaType、jdbcType、mode、numericScale、resultMap、typeHandler、jdbcTypeName等

jdbcType

参数也可以指定一个特殊的数据类型

#{property,javaType=int,jdbcType=NUMERIC}
#{height,javaType=double,jdbcType=NUMERIC,numericScale=2}
复制代码

• javaType通常可以从参数对象中确定
• 如果null被当作值来传递，对于所有可能为空的列，需要设置jdbcType
• 对于数值类型，可以设置小数点后保留的位数

<select id="getEmpByIdAndEmpName" resultType="com.citi.entity.Employee">
    select * from t_employee where id = #{id,jdbcType=INTEGER} and empname = #{name}
</select>
复制代码

#{}与${}

获取参数的值可以使用#{}或者${}

• #{key}：预编译到SQL中，较安全
• ${key}：拼接到SQL中，会有SQL注入漏洞问题

修改getEmployeeByIdAndEmpName方法对应的SQL语句，使用${}取值

<select id="getEmpByIdAndEmpName" resultType="com.citi.entity.Employee">
    select * from t_employee where id = ${id} and empname = #{name}
</select>
复制代码

执行测试，查看执行的SQL可以发现id=1是直接拼接到SQL中的

SQL语句中只有参数位置是支持预编译的，${}可以用作动态传递表名

修改getEmployeeByIdAndName测试方法，在paramMap中增加表名信息

@Test
public void getEmployeeByIdAndName(){

    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    Map<String, Object> paramMap = new HashMap<>();
    paramMap.put("id",1);
    paramMap.put("name","stark");
    paramMap.put("tableName","t_employee");
    Employee employee = employeeDao.getEmployeeByIdAndName(paramMap);

    System.out.println(employee);
}
复制代码

修改getEmployeeByIdAndName的映射SQL，使用${tableName}获取表名

<select id="getEmployeeByIdAndName" resultType="com.citi.entity.Employee">
    select * from ${tableName} where id = #{id} and empname = #{name}
</select>
复制代码

执行测试

如果使用#{}传递表名，修改getEmployeeByIdAndName的映射SQL，使用#{tableName}获取表名，再次执行测试

出现报错，SQL语句中只有参数位置是支持预编译的

查询返回List

EmployeeDao接口中新增方法getAllEmployees，查询所有的员工

List<Employee> getAllEmployees();
复制代码

employee.xml 增加映射SQL

<!--如果返回的是集合，resultType写的是集合中元素的类型-->
<select id="getAllEmployees" resultType="com.citi.entity.Employee">
    select * from t_employee
</select>
复制代码

增加测试方法

@Test
public void getAllEmployees(){
    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    List<Employee> employeeList = employeeDao.getAllEmployees();
    for (Employee employee : employeeList) {
        System.out.println(employee);
    }
}
复制代码

执行该测试方法

查询结果封装成Map

查询返回单条记录的情况下列名作为Key，值作为Value

新增方法

Map<String, Object> getEmployeeByIdWithMap(Integer id);
复制代码

增加SQL映射语句，由于返回的是Map类型数据，所以resultType为map

<select id="getEmployeeByIdWithMap" resultType="map">
    select * from t_employee where id = #{id}
</select>
复制代码

增加测试方法

@Test
public void getEmployeeByIdWithMap(){
    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    Map<String, Object> employeeMap = employeeDao.getEmployeeByIdWithMap(1);
    System.out.println(employeeMap);
}
复制代码

执行测试 默认封装成Map后，列名作为Key，值作为Value

查询返回多条记录情况下封装成Map

定义方法

Map<Integer, Employee> getAllEmployeesWithMap();
复制代码

employee.xml中增加SQL映射语句

<select id="getAllEmployeesWithMap" resultType="map">
    select * from t_employee
</select>
复制代码

增加测试方法

@Test
public void getAllEmployeesWithMap(){
    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    Map<Integer, Employee> employeeMap = employeeDao.getAllEmployeesWithMap();
    System.out.println(employeeMap);
}
复制代码

执行测试

将

增加主键定义，使用@MapKey指定一个Map的主键

@MapKey("id")
Map<Integer, Employee> getAllEmployeesWithMap();
复制代码

再次执行测试

在测试方法中打印出key为1的元素的属性，在getAllEmployeesWithMap测试方法中增加代码

@Test
public void getAllEmployeesWithMap(){
    EmployeeDao employeeDao = openSession.getMapper(EmployeeDao.class);
    Map<Integer, Employee> employeeMap = employeeDao.getAllEmployeesWithMap();
    System.out.println(employeeMap);
    Employee employee = employeeMap.get(1);
    System.out.println(employee.getEmpName());
}
复制代码

出现了类型转换异常 这是因为SQL映射语句中定义的resultType为Map，所以会出现这种错误，修改sql映射语句中resultType类型要是集合中元素的类型

<select id="getAllEmployeesWithMap" resultType="com.citi.entity.Employee">
    select * from t_employee
</select>
复制代码

再次测试

查询多条数据返回一个Map，resultType为集合Value保存的元素的类型