Java研学-MyBatis加强(一)

一 基础准备

1 数据库表

CREATE TABLE `user` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `username` varchar(20) DEFAULT NULL,
  `password` varchar(20) DEFAULT NULL,
  `trueName` varchar(20) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

2 pom中添加依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <!--项目信息，打包方式，添加依赖及插件等-->
    <modelVersion>4.0.0</modelVersion>
    <groupId>cn.tj</groupId>
    <artifactId>play_maven</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--修改打包方式-->
    <packaging>war</packaging>
    <!--添加依赖信息名称版本作用域-->
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.23</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <!-- 测试阶段 -->
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.22</version>
            <!-- 编译和测试阶段 -->
            <scope>provided</scope>
        </dependency>
    </dependencies>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>16</maven.compiler.source>
        <maven.compiler.target>16</maven.compiler.target>
    </properties>
</project>

3 resources 目录

db.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///play_web
jdbc.username=root
jdbc.password=root

log4j.properties

log4j.rootLogger=ERROR, stdout
log4j.logger.cn.tj=TRACE
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="db.properties"></properties>
    <typeAliases>
        <package name="cn.tj.domain"/>
    </typeAliases>
    <environments default="dev">
        <environment id="dev">
            <transactionManager type="JDBC"></transactionManager>
            <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="cn/tj/mapper/UserMapper.xml"></mapper>-->
        <package name="cn.tj.mapper"/>
    </mappers>
</configuration>

4 MyBatisUtil

public class MybatisUtil {
    private  static SqlSessionFactory factory=null;
    static {
        try {
            InputStream rs = Resources.getResourceAsStream("mybatis-config.xml");
             factory = new SqlSessionFactoryBuilder().build(rs);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    public static SqlSession getSqlSession(){
        return factory.openSession(true);
    }
}

5 实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private  Long id;
    private  String username;
    private  String password;
    private  String trueName;
}

6 UserMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--resources 目录下对应java目录新建 cn/tj/mapper/UserMapper.xml-->
<mapper namespace="cn.tj.mapper.UserMapper">
    <insert id="insertUser">
        insert into user(username,password,trueName)values(#{username},#{password},#{trueName})
    </insert>
</mapper>

二 面向Mapper接口编程

1 注意事项

  Mapper 组件 = Mapper 接口 + Mapper XML 文件
① 接口命名为实体名+Mapper，一般和其对应 XML 文件放一起（只要编译之后字节码文件和 XML 文件在一起）
② XML 命名空间为对应接口的全限定名（单击xml的namespace跳转对应mapper接口）
③ Mapper 接口的方法名要和 XML 中sql标签的id 值一样
④ 方法的返回类型与 SQL 元素中定义的 resultType / resultMap 类型保持一致
⑤ 方法的参数类型对应 SQL 元素中定义的 paramterType 类型

2 定义 Mapper 接口

public interface UserMapper {
    int insertUser(User user);
}

3 Mapper 接口测试

public class UserMapperTest extends TestCase {
    public void testInsertUser() {
        // 创建SqlSession对象
        SqlSession sqlSession = MybatisUtil.getSqlSession();
        // 获取mapper接口对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        // 调用接口方法
        userMapper.insertUser(new User(null,"blue","123456","小蓝"));
    }
}

4 接口原理

  Mapper接口是MyBatis框架中用于定义数据库操作的接口。它通过注解或XML配置文件的方式，将接口与对应的SQL语句进行绑定，实现了数据库操作的映射关系。

  MyBatis 底层使用动态代理生成 Mapper 接口的实现(通过接口规范，动态代理代替我们生成实现类对象完成操作)，程序员只需提供 Mapper 接口对应 Mapper XML 文件，获取实现类对象的时候传入 Mapper 接口就可以了

  Mapper接口中的方法名与对应的SQL语句进行映射。MyBatis框架通过接口的全限名和方法名拼接成一个唯一的key值，用于定位对应的SQL语句。代理对象会根据方法名和参数，动态生成对应的SQL语句，并执行数据库操作

三 MyBatis 多参数处理

1 多参数异常

  当同时传递多个参数时，调用会抛出异常，因为本质接口的底层方法没有变(支持一个参数)，如下：

User login(String username, String password,String trueName);
<select id="login" resultType="User">
    SELECT id, username,password,trueName FROM user
    WHERE username = #{username} AND password = #{password} AND trueName= #{trueName}
</select>

2 xml方式

  对于多个参数，可以将多个参数封装成一个参数(map或者实体类对象)传入

// 两种方式
User login(Map<String, Object> user);
User login(User user);
// 两种方式的对应sql
<select id="login" resultType="User">
    SELECT id, username, password,trueName FROM user
    WHERE username = #{username} AND password = #{password} AND trueName= #{trueName}
</select>

3 注解方式

// 底层构建一个 Map 对象，key 为注解 @Param 的值，value 为参数的值。
User login(@Param("username")String username, @Param("password")String password, @Param("trueName")String trueName);

4 集合/数组参数

  MyBatis在传递一个集合或数组对象参数时，会将其转换为Map对象进行处理。如果不指定参数名，MyBatis会将集合或数组对象的默认参数名设置为"array"，并将其作为Map的key，将集合或数组对象的值作为Map的value。这样在SQL语句中就可以通过"array"来引用这个集合或数组对象。

  如果你想使用自定义的参数名，可以在参数前面加上@param注解来指定参数名。这样在SQL语句中就可以通过自定义的参数名来引用这个集合或数组对象。

  总结起来，通过MyBatis传递集合或数组对象参数时，可以使用默认的参数名"array"，也可以使用自定义的参数名，通过@param注解来指定。

四 MyBatis 中 #与$的异同

1、相同点

  都能获取对象信息（Map 对象或者 JavaBean 对象）

2、不同点

  ① # 类似 PrepareStatement，无 SQL 注入问题； $ 类似 Statement，会有 SQL 注入问题。
  ② # 传递的参数会先转换为 ?，传递任意类型数据都会带一个单引号；$ 传递的参数，直接把值作为 SQL 语句的一部分。
  ③ # 支持简单类型参数作为值（基本数据类型及其包装类、String、BigDecimal 等）；$ 不支持

3 例子

// #的语句为 SELECT username FROM user WHERE username = 'yellow'
User queryByUsername1(String username);
<select id="queryByUsername1" resultType="User">
    SELECT username FROM user WHERE username = #{username}
</select>

// $的语句为 SELECT username FROM user WHERE username = yellow
// 需要在传递参数时传递"'yellow'" sql才能执行-->
User queryByUsername2(@Param("username")String name);
<select id="queryByUsername2" resultType="User">
    SELECT username FROM user WHERE username = ${username}
</select>

// ORDER BY 或 GROUP BY 子句获取参数值使用 $；其它子句获取参数值使用 #。

五 动态 SQL

1 介绍

  MyBatis 特性之一，MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集，可以使用简单的 XML 或注解来配置和映射原生信息，在运行时根据参数值动态地生成 SQL 语句。能够根据不同的条件构建查询，例如在查询数据库时，可根据用户的输入来动态地改变查询条件。

  MyBatis 提供了几种动态 SQL 元素，如 、、、、、 和 等，可根据实际需要选择使用，虽然使用动态SQL可以提高查询的灵活性，但也要谨慎使用，避免产生SQL注入等安全问题。

2 数据库表

CREATE TABLE `employee` (
  `id` bigint(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(50) DEFAULT NULL,
  `salary` double(10,2) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8;

3 实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Employee {
	private Long id;
	private String name;
	private Double salary;
}

4 Mapper 接口

public interface EmployeeMapper {
}

5 Mapper XML

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.tj.mapper.EmployeeMapper">
</mapper>

6 动态SQL的 if,where

  传递参数可对查询范围进行限定，传递null值则表示查询全部

// 查询工资大于8200的员工
// 接口
List<Employee> queryBySalary(@Param("salary") Double salary);
// xml
    <select id="queryBySalary" resultType="employee">
        select * from employee
        <where>
            <if test="salary!=null">
                salary >= #{salary}
            </if>
        </where>
    </select>
// 测试类
	public void testQueryBySalary() {
        SqlSession session = MybatisUtil.getSqlSession();
        EmployeeMapper employeeMapper = session.getMapper(EmployeeMapper.class);
        List<Employee> employees = employeeMapper.queryBySalary(new Double("8200"));
        // 若传了 null 就要把所有员工查询出来
        // List<Employee> employees = employeeMapper.queryBySalary(null);
        System.out.println(employees);
        session.close();
    }

// 根据工资范围查询员工
// 接口
List<Employee> queryBySalaryCondition(@Param("minSal")Double minSal,@Param("maxSal")Double maxSal);
// xml
	<select id="queryBySalaryCondition" resultType="employee">
        select * from employee
        <where>
            <if test="minSal!=null">
                and Salary >=#{minSal}
            </if>
            <if test="maxSal!=null">
                and #{maxSal} >= Salary
            </if>
        </where>
    </select>
// 测试类
    public void testQueryBySalaryCondition() {
        SqlSession session = MybatisUtil.getSqlSession();
        EmployeeMapper employeeMapper = session.getMapper(EmployeeMapper.class);
        List<Employee> employees = employeeMapper
                .queryBySalaryCondition(new Double("8000"), new Double("9000"));
        // List<Employee> employees = employeeMapper.queryBySalaryCondition(null, null);
        System.out.println(employees);
        session.close();
    }

7 动态 SQL的 set

  set 元素会动态前置 SET 关键字，自动补全或删除逗号，若条件都不成立，就会去除 SET 关键字。(防止空值传递为null)

// 给员工涨工资
// 接口
int updateById(Employee employee);
// xml
	<update id="updateById">
        update employee
        <set>
            <if test="name!=null">
                name=#{name},
            </if>
            <if test="salary!=null">
                salary=#{salary}
            </if>
        </set>
        where id=#{id}
    </update>
// 测试类
    public void testUpdateById() {
        SqlSession session = MybatisUtil.getSqlSession();
        EmployeeMapper employeeMapper = session.getMapper(EmployeeMapper.class);
        Employee employee = new Employee();
        employee.setSalary(new Double("6537"));
        employee.setId(3L);
        employeeMapper.updateById(employee);
        session.commit();
        session.close();
    }

8 动态 SQL 的 foreach

  对集合进行遍历（IN 条件语句时）

// 根据员工id查询员工信息
// 接口
List<Employee> queryEmpByIds(@Param("arr") List<Long> ids);
// xml
// collection  遍历数组或集合的 key 或者属性名
// open        遍历开始拼接的字符串
// index       遍历索引
// item        遍历元素
// separator   每遍历元素拼接字符串
// close       遍历结束拼接字符串

	<select id="queryEmpByIds" resultType="employee">
        select * from employee where id in
        <foreach collection="arr" item="id"
                 separator="," open="(" close=")">
            #{id}
        </foreach>
    </select>
// 测试类
    public void testQueryEmpByIds() {
        SqlSession sqlSession = MybatisUtil.getSqlSession();
        EmployeeMapper mapper = sqlSession.getMapper(EmployeeMapper.class);
        List<Long> list=new ArrayList<>();
        list.add(3l);
        list.add(4l);
        list.add(5l);
        System.out.println(list);
        mapper.queryEmpByIds(list);
    }