SqlMapperConfig.xml

属性的介绍可以查看 https://mybatis.org/mybatis-3/zh/configuration.html#settings

Properties

就是Mybatis中config和sqlMapper配置文件的一些说明。
首先说properties，之前我们将数据库的连接信息直接写在config.xml中，现在可以使用properties文件来替换，在config.xml中引入

  1. // 文件jdbc.properties的内容如下
  2. jdbc.driver=com.mysql.cj.jdbc.Driver
  3. jdbc.url=jdbc:mysql:///zdy_mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
  4. jdbc.user=root
  5. jdbc.password=nrblwbb7
  7. // SqlMapperConfig.xml修改如下
  8. <?xml version="1.0" encoding="UTF-8" ?>
  9. <!DOCTYPE configuration
  10.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  11.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
  12. <configuration>
  14.     <!--加载外部的jdbc环境-->
  15.     <properties resource="jdbc.properties"/>
  17.     <!--指定当前使用的环境-->
  18.     <environments default="dev">
  19.         <!--可以配置多个，比如说开发环境、测试环境、生产环境-->
  20.         <environment id="dev">
  21.             <!--表示使用JDBC的事务-->
  22.             <transactionManager type="JDBC"/>
  23.             <!--表示使用mybatis的连接池-->
  24.             <dataSource type="POOLED">
  25.                 <!--配置数据库连接信息，我这里使用的是mysql8-->
  26.                 <property name="driver" value="${jdbc.driver}"/>
  27.                 <property name="url" value="${jdbc.url}"/>
  28.                 <property name="username" value="${jdbc.user}"/>
  29.                 <property name="password" value="${jdbc.password}"/>
  30.             </dataSource>
  31.         </environment>
  32.     </environments>
  34.     <mappers>
  35.         <mapper resource="UserMapper.xml"/>
  36.     </mappers>
  37. </configuration>

需要注意的点是SqlMapperConfig.xml中，对标签的顺序有着严格的规定，也就是properties必须在xml的最前面。如果位置顺序不对，xml文件会报错。如下

  1. The content of element type "configuration" must match "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)".

typeAliases

这个标签的含义就是起别名，出发点是方便开发者去书写返回类型和参数类型，不必再写全限定类名。并且对于Java内置的类型，Mybatis已经帮我们做好了别名，链接：https://mybatis.org/mybatis-3/zh/configuration.html#typeAliases
自定义类型使用如下：

  1. // sqlMapperConfig.xml
  2. <?xml version="1.0" encoding="UTF-8" ?>
  3. <!DOCTYPE configuration
  4.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  5.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
  6. <configuration>
  8.     <!--加载外部的jdbc环境-->
  9.     <properties resource="jdbc.properties"/>
  11.     <typeAliases>
  12.         <!--只能给单个类起别名-->
  13.         <!--<typeAlias type="com.wangzhi.pojo.User" alias="user"/>-->
  14.         <!--批量起别名: 规则是该包下所有类起别名，不区分大小写，只要字母相同就行，具体在mapper中的体现在UserMapper.xml-->
  15.         <package name="com.wangzhi.pojo"/>
  16.     </typeAliases>
  18.     <!--指定当前使用的环境-->
  19.     <environments default="dev">
  20.         <!--可以配置多个，比如说开发环境、测试环境、生产环境-->
  21.         <environment id="dev">
  22.             <!--表示使用JDBC的事务-->
  23.             <transactionManager type="JDBC"/>
  24.             <!--表示使用mybatis的连接池-->
  25.             <dataSource type="POOLED">
  26.                 <!--配置数据库连接信息，我这里使用的是mysql8-->
  27.                 <property name="driver" value="${jdbc.driver}"/>
  28.                 <property name="url" value="${jdbc.url}"/>
  29.                 <property name="username" value="${jdbc.user}"/>
  30.                 <property name="password" value="${jdbc.password}"/>
  31.             </dataSource>
  32.         </environment>
  33.     </environments>
  35.     <mappers>
  36.         <mapper resource="UserMapper.xml"/>
  37.     </mappers>
  38. </configuration>
  39. // UserMapper.xml
  40. <?xml version="1.0" encoding="UTF-8" ?>
  41. <!DOCTYPE mapper
  42.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  43.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  44. <mapper namespace="com.wangzhi.dao.UserMapper">
  45.     <select id="selectAll" resultType="user">
  46.         SELECT * FROM user
  47.     </select>
  49.     <select id="findAll" resultType="user">
  50.         SELECT * FROM user
  51.     </select>
  53.     <insert id="insertUser" parameterType="user">
  54.         INSERT INTO user VALUES (#{id}, #{name})
  55.     </insert>
  57.     <update id="updateUser" parameterType="user">
  58.         UPDATE user SET name = #{name} WHERE id = #{id}
  59.     </update>
  61.     <delete id="deleteUser" parameterType="int">
  62.         DELETE FROM user WHERE id = #{id}
  63.     </delete>
  64. </mapper>

可以看到UserMapper的所有的返回类型和参数类型的书写不会存在包路径。

SqlMapper.xml

动态sql很重要。
常用的就是if和foreach，还有一个是抽取sql。

  1. // UserMapper接口新增：
  3. User selectByUserCondition(User user);
  5. List<User> findByIds(@Param("ids") List<Integer> ids);
  7. // UserMapper.xml新增：
  9. <select id="selectByUserCondition" resultType="com.wangzhi.pojo.User">
  10.         SELECT * FROM user
  11.         <where>
  12.             <if test="id != null">
  13.                 AND id = #{id}
  14.             </if>
  15.             <if test="name != null">
  16.                 AND name = #{name}
  17.             </if>
  18.         </where>
  19.     </select>
  21.     <select id="findByIds" parameterType="list" resultType="User">
  22.         SELECT * FROM user
  23.         <where>
  24.             <if test="ids != null and ids.size() != 0">
  25.                 AND id in <foreach collection="ids" open="(" close=")" separator="," item="id">
  26.                 #{id}
  27.             </foreach>
  28.             </if>
  29.         </where>
  30.     </select>
  32. // 测试类新增
  33. @Test
  34.     public void testDynamicQuery() throws IOException {
  35.         InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapperConfig.xml");
  36.         SqlSession sqlSession = new SqlSessionFactoryBuilder().build(resourceAsStream).openSession();
  37.         User user = new User();
  38.         user.setId(2);
  39.         UserMapper mapper = sqlSession.getMapper(UserMapper.class);
  40.         User user1 = mapper.selectByUserCondition(user);
  41.         System.out.println(user1);
  42.     }
  44.     @Test
  45.     public void testDynamicQueryFor() throws IOException {
  46.         InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapperConfig.xml");
  47.         SqlSession sqlSession = new SqlSessionFactoryBuilder().build(resourceAsStream).openSession();
  48.         List<Integer> list = new ArrayList<>();
  49.         list.add(1);
  50.         list.add(2);
  51.         UserMapper mapper = sqlSession.getMapper(UserMapper.class);
  52.         List<User> byIds = mapper.findByIds(list);
  53.         byIds.forEach(System.out::println);
  54.     }

至于sql的抽取，这里在UserMapper.xml中存在很多的 select * from user，抽取如下，正式的生产环境是不可能存在这种代码的，我在生产环境会抽取字段：

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper
  3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="com.wangzhi.dao.UserMapper">
  7.     <!--抽取-->
  8.     <sql id="selectAll">
  9.         SELECT * FROM user
  10.     </sql>
  12.     <select id="selectAll" resultType="user">
  13.         <include refid="selectAll"/>
  14.     </select>
  16.     <select id="findAll" resultType="user">
  17.         <include refid="selectAll"/>
  18.     </select>
  20.     <insert id="insertUser" parameterType="user">
  21.         INSERT INTO user VALUES (#{id}, #{name})
  22.     </insert>
  24.     <update id="updateUser" parameterType="user">
  25.         UPDATE user SET name = #{name} WHERE id = #{id}
  26.     </update>
  28.     <delete id="deleteUser" parameterType="int">
  29.         DELETE FROM user WHERE id = #{id}
  30.     </delete>
  32.     <select id="selectByUserCondition" resultType="com.wangzhi.pojo.User">
  33.         <include refid="selectAll"/>
  34.         <where>
  35.             <if test="id != null">
  36.                 AND id = #{id}
  37.             </if>
  38.             <if test="name != null">
  39.                 AND name = #{name}
  40.             </if>
  41.         </where>
  42.     </select>
  44.     <select id="findByIds" parameterType="list" resultType="User">
  45.         <include refid="selectAll"/>
  46.         <where>
  47.             <if test="ids != null and ids.size() != 0">
  48.                 AND id in <foreach collection="ids" open="(" close=")" separator="," item="id">
  49.                 #{id}
  50.             </foreach>
  51.             </if>
  52.         </where>
  53.     </select>
  54. </mapper>

sql片段抽取，include标签引用。