本章节将介绍 <sql> 元素，使用该元素可以定义一个 SQL 片段。然后在 Mapper.xml 文件中使用 <include> 标签根据 ID 引用 SQL 片段。
要使用 <sql> 元素，我们需要先了解 <sql> 元素的 DTD 定义，如下：
<!ELEMENT sql (#PCDATA | include | trim | where | set | foreach | choose | if | bind)*> <!ATTLIST sql id CDATA #REQUIRED lang CDATA #IMPLIED databaseId CDATA #IMPLIED>
MyBatis 中 <sql> 元素用于定义一个 SQL 片段，用于分离一些公共的 SQL 语句，例如：SELECT 关键字和 WHERE 关键字之间的部分。其中：
id：唯一标识符，用于在其他地方使用 <include> 标签引用；
lang：设置字符编码；
databaseId：指定执行该 SQL 语句的数据库ID，数据库ID在 mybatis-cfg.xml 中的 <environment> 中配置。
同时，你也能够看见 <sql> 标签中可以使用 <include>、<trim>、<where>、<set>、<foreach>、<choose>、<if>、<bind> 等标签定义复杂的 SQL 片段。例如：
<sql id="user_columns"> `user_id`, `name`, `sex`, `age` </sql>
在 <sql> 标签中使用 <include> 标签，如下：
<!-- 定义基础列 --> <sql id="user_base_columns"> `user_id`, `name` </sql> <!-- 定义一个SQL片段 --> <sql id="user_columns"> <include refid="user_base_columns"/>, `sex`, `age` </sql>
下面将通过本实例演示怎样使用 <sql> 标签。
（1）MyBatis 配置文件 mybatis-cfg.xml 文件内容如下：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<properties resource="database.properties"/>
<environments default="MySqlDatabase" >
<environment id="MySqlDatabase" >
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com\hxstrive\mybatis\sql\demo1\UserMapper.xml" />
</mappers>
</configuration>（2）定义 Mapper 接口 UserMapper.java 文件，内容如下：
package com.hxstrive.mybatis.sql.demo1;
import java.util.List;
public interface UserMapper {
/** 查询所有用户信息 */
List<UserBean> findAll();
}（3）定义 Mapper XML文件 UserMapper.xml，内容如下：
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "https://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.hxstrive.mybatis.sql.demo1.UserMapper"> <!-- 映射结果 --> <resultMap id="RESULT_MAP" type="com.hxstrive.mybatis.sql.demo1.UserBean"> <id column="user_id" jdbcType="INTEGER" property="userId" /> <result column="name" jdbcType="VARCHAR" property="name" /> <result column="sex" jdbcType="VARCHAR" property="sex" /> <result column="age" jdbcType="INTEGER" property="age" /> </resultMap> <!-- 定义一个SQL片段 --> <sql id="user_columns"> `user_id`, `name`, `sex`, `age` </sql> <!-- 查询所有用户信息 --> <select id="findAll" resultMap="RESULT_MAP"> select <include refid="user_columns" /> from `user` </select> </mapper>
（4）定义返回结果实体Bean UserBean.java，内容如下：
package com.hxstrive.mybatis.sql.demo1;
public class UserBean {
private Integer userId;
private String name;
private String sex;
private Integer age;
// 忽略 setter和getter
@Override
public String toString() {
return "UserBean{" +
"userId=" + userId +
", name='" + name + '\'' +
", sex='" + sex + '\'' +
", age=" + age +
'}';
}
}（5）客户端代码如下：
package com.hxstrive.mybatis.sql.demo1;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
public class SqlDemo1 {
public static void main(String[] args) throws Exception {
new SqlDemo1();
}
public SqlDemo1() throws IOException {
// 获取 Mapper 对象
String cfgName = "com/hxstrive/mybatis/sql/demo1/mybatis-cfg.xml";
InputStream input = Resources.getResourceAsStream(cfgName);
SqlSessionFactoryBuilder factoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory sqlFactory = factoryBuilder.build(input);
SqlSession sqlSession = sqlFactory.openSession(true);
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 查询所有用户
List<UserBean> userBeanList = userMapper.findAll();
for(UserBean userBean : userBeanList) {
System.out.println(userBean);
}
}
}运行结果如下：
UserBean{userId=1, name='ZhangSan', sex='男', age=28}
UserBean{userId=2, name='李艳', sex='女', age=27}
UserBean{userId=3, name='ZhaoLiu', sex='男', age=28}
川公网安备51010802032098
