MyBatis-获取参数值的多种方法

三、MyBatis获取参数值的多种方法(重点)

MyBatis获取参数值的两种方式：${}和#{}

${}的本质就是字符串拼接，#{}的本质就是占位符赋值

${}使用字符串拼接的方式拼接sql，若为字符串类型或日期类型的字段进行赋值时，需要手动加单引号；但是#{}使用占位符赋值的方式拼接sql，此时为字符串类型或日期类型的字段进行赋值时，可以自动添加单引号

能用#{}就不用$[}，因为${}会引起sql注入

1、前期准备

1）新建模块，然后导入依赖，并配置log4j日志文件：

导入依赖：

<groupId>com.atguigu.mybatis</groupId>
<artifactId>MyBatis-获取参数值</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
​
<!--引入依赖-->
<dependencies>
    <!--MyBatis核心-->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.7</version>
    </dependency>
​
    <!--junit测试-->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
​
    <!--MySQL驱动-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
    </dependency>
​
    <!--Log4j日志-->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
</dependencies>

加入log4j的配置文件：log4j的配置文件名为log4j.xml，存放的位置是src/main/resourcesml下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
​
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
​
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Encoding" value="UTF-8" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS} %m (%F:%L) \n" />
        </layout>
    </appender>
    <logger name="java.sql">
        <level value="debug" />
    </logger>
    <logger name="org.apache.ibatis">
        <level value="info" />
    </logger>
    <root>
        <level value="debug" />
        <appender-ref ref="STDOUT" />
    </root>
​
</log4j:configuration>

2）在java目录下新建com.atguigu.mybatis目录，并在其下新建pojo包和mapper包分别用于存放实体类和mapper接口。在resources根目录下新建com/atguigu/mybatis/mapper目录，用于存放mapper映射文件。

3）配置mybatis-config核心配置文件

<?xml version="1.0" encoding="UTF-8" ?>   <!--用于声明该xml文件的版本号及编码方式-->
<!--mybatis配置文件中的约束-->
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
​
<configuration>
​
    <!--引入jdbc.properties，用来设置连接数据库的信息-->
    <properties resource="jdbc.properties" />
​
    <!--设置类型别名-->
    <typeAliases>
        <!--以包为单位，将包下所有类型设置为默认的类型别名，即类名，且不区分大小写。该方法更常用-->
        <package name="com.atguigu.mybatis.pojo"/>
    </typeAliases>
​
    <!--配置连接数据库的环境-->
    <environments default="development">
        <!--配置某个具体的环境-->
        <environment id="development">
            <!--设置事务管理器的类型为JDBC-->
            <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>
        <!--以包为单位引入映射文件-->
        <package name="com.atguigu.mybatis.mapper"/>
    </mappers>
</configuration>

4）在pojo包下新建User类并设置：

public class User {
​
    private  Integer id;
    private String username;
    private String password;
    private Integer age;
    private String sex;
    private String email;
​
    //设置有参构造(快捷键：Alt+Insert)
    public User(Integer id, String username, String password, Integer age, String sex, String email) {
        this.id = id;
        this.username = username;
        this.password = password;
        this.age = age;
        this.sex = sex;
        this.email = email;
    }
​
    //设置无参构造(快捷键：Alt+Insert)
    public User() {
    }
​
    //设置Setter和Getter方法(快捷键：Alt+Insert)
    public Integer getId() {
        return id;
    }
​
    public void setId(Integer id) {
        this.id = id;
    }
​
    public String getUsername() {
        return username;
    }
​
    public void setUsername(String username) {
        this.username = username;
    }
​
    public String getPassword() {
        return password;
    }
​
    public void setPassword(String password) {
        this.password = password;
    }
​
    public Integer getAge() {
        return age;
    }
​
    public void setAge(Integer age) {
        this.age = age;
    }
​
    public String getSex() {
        return sex;
    }
​
    public void setSex(String sex) {
        this.sex = sex;
    }
​
    public String getEmail() {
        return email;
    }
​
    public void setEmail(String email) {
        this.email = email;
    }
​
    //设置toString(快捷键：Alt+Insert)
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", age=" + age +
                ", sex='" + sex + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

在mapper包下新建ParameterMapper接口并配置：

public interface ParameterMapper {
​
    //查询所有员工信息
    List<User> getAllUser();
​
}

在mapper目录下新建ParameterMapper.xml映射文件并配置：

<?xml version="1.0" encoding="UTF-8" ?>
<!--mybatis配置文件中的约束-->
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
​
<!--将该mapper映射文件与UserMapper接口关联-->
<mapper namespace="com.atguigu.mybatis.mapper.ParameterMapper">
​
    <!--实现查询所有员工信息的功能。将该SQL语句的方法与mapper接口中getAllUser()方法关联-->
    <select id="getAllUser" resultType="User">
        select * from t_user
    </select>
​
</mapper>

5）封装SqlSessionUtils工具类：在mybatis包下新建utils包，用于存放获取SqlSession类的封装类，即使用一个类来封装获取SqlSession类的过程，当之后需要获取SqlSession类时，只需调用该类即可实现SqlSession类的获取。然后在utils包下新建SqlSessionUtils类，并配置：

public class SqlSessionUtils {
​
    public static SqlSession getSqlSession(){
        SqlSession sqlSession = null;
        try{
            //加载核心配置文件
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            //获取SqlSessionFactory
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            //获取SqlSession。设置为true时，会自动提交事务
            sqlSession = sqlSessionFactory.openSession(true);
        } catch (IOException e) {
            e.printStackTrace();
        }
        //返回sqlSession
        return sqlSession;
    }
​
}

6）在test/java目录下新建com.atguigu.mybatis.test包，用于存放测试类，并在其下新建TestParameterMapper类并配置：

//测试获取所有用户信息的功能
@Test
public void testGetAllUser(){
    SqlSession sqlSession = SqlSessionUtils.getSqlSession();
    ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
    List<User> list = mapper.getAllUser();
    for(User user : list){
        System.out.println(user);
    }
}

1、单个字面量类型的参数

若mapper接口中的方法参数为单个的字面量类型，由于#{}和${}的赋值只和顺序有关而与名称无关，所以此时可以使用${}和#{}以任意的名称获取参数的值，注意${}需要手动加单引号。

1）实现根据用户名查询用户信息的功能：

在mapper接口文件ParamererMapper.java中配置：

//根据用户名查询用户信息
User getUserByUsername(String username);

2）在mapper映射文件ParameterMapper.xml中关联mapper接口文件：

<!--实现根据用户名查询用户信息的功能。将该SQL语句的方法与mapper接口中getUserByUsername(String username)方法关联-->
<select id="getUserByUsername" resultType="User">
    <!--使用#{}时，大括号里的名称可以写成任意名称如#{aaa}等。因为使用#{}进行赋值时，只和赋值顺序有关，和名称无关-->
    <!--select * from t_user where username = #{username}-->
    <!--使用${}时，大括号里的名称也可以写成任意名称，但是还需要加上''以符合sql语法-->
    select * from t_user where username = '${username}'
</select>

3）在TestParameterMapper.java测试类中编写测试方法：

/**
* MyBatis获取参数值的两种方式：${}和#{}
* ${}本质是字符串拼接
* #{}本质是占位符赋值
* 能用#{}就不用$[}，因为${}会引起sql注入
*
* MyBatis获取参数值的各种情况：
*   1.mapper接口方法的参数为单个的字面量类型：
*     可以通过${}和#{}以任意的名称获取参数值，但是需要注意${}的单引号问题
*   2.mapper接口方法的参数为多个字面量类型：
*     此时MyBatis会将这些参数放在一个map集合中以两种方式进行存储：
*       a>以arg0，arg1，...为key，以参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*   3、若mapper接口方法的参数有多个时，可以手动将这些参数放在一个map中来存储：
*     此时只需要通过#{}和${}以键的方式来访问值即可，而#{}和${}中的名称以自己定义的
*     map的key为准但是需要注意${}的单引号问题
*   4、mapper接口方法的参数为实体类类型：
*     只需要通过#{}和${}以实体类中属性名的方式访问属性值即可，但是要注意${}的单引号问题
*   5、使用@Param注解命名参数：
*     此时MyBatis会将这些参数放在一个map集合中，以两种方式进行存储：
*       a>以@Param注解中的值为key，以之后的参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*/
//测试根据用户名获取用户信息的功能
@Test
public void testGetUserByUsername(){
    SqlSession sqlSession = SqlSessionUtils.getSqlSession();
    ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
    User user = mapper.getUserByUsername("admin");
    System.out.println(user);
}

2、多个字面量类型的参数

若mapper接口中的方法参数为多个时。此时MyBatis会自动将这些参数放在一个map集合中，以arg0,arg1,...为键，以参数为值；或者以param1,param2,...为键，以参数为值；因此只需要通过${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号。

1）实现验证登录的功能：

在mapper接口文件ParamererMapper.java中配置：

//验证登录
User checkLogin(String username, String password);

2）在mapper映射文件ParameterMapper.xml中关联mapper接口文件：

<!--实现验证登录的功能。将该SQL语句的方法与mapper接口中checkLogin(String username, String password)方法关联-->
<select id="checkLogin" resultType="User">
    <!--
        当参数为多个字面量类型时，系统会自动把多个参数放入一个map集合中([arg1, arg0, param1, param2])，
        然后以arg为key，以参数为value，或者以param为key，以参数为value。因此有多个参数时，使用arg或者param来赋值。
        -->
    <!--select * from t_user where username = #{arg0} and password = #{arg1}-->
    <!--select * from t_user where username = #{param1} and password = #{param2}-->
    select * from t_user where username = '${arg0}' and password = '${arg1}'
</select>

3）在TestParameterMapper.java测试类中编写测试方法：

/**
* MyBatis获取参数值的两种方式：${}和#{}
* ${}本质是字符串拼接
* #{}本质是占位符赋值
* 能用#{}就不用$[}，因为${}会引起sql注入
*
* MyBatis获取参数值的各种情况：
*   1.mapper接口方法的参数为单个的字面量类型：
*     可以通过${}和#{}以任意的名称获取参数值，但是需要注意${}的单引号问题
*   2.mapper接口方法的参数为多个字面量类型：
*     此时MyBatis会将这些参数放在一个map集合中以两种方式进行存储：
*       a>以arg0，arg1，...为key，以参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*   3、若mapper接口方法的参数有多个时，可以手动将这些参数放在一个map中来存储：
*     此时只需要通过#{}和${}以键的方式来访问值即可，而#{}和${}中的名称以自己定义的
*     map的key为准但是需要注意${}的单引号问题
*   4、mapper接口方法的参数为实体类类型：
*     只需要通过#{}和${}以实体类中属性名的方式访问属性值即可，但是要注意${}的单引号问题
*   5、使用@Param注解命名参数：
*     此时MyBatis会将这些参数放在一个map集合中，以两种方式进行存储：
*       a>以@Param注解中的值为key，以之后的参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*/
//测试验证登录的功能
@Test
public void testCheckLogin(){
    SqlSession sqlSession = SqlSessionUtils.getSqlSession();
    ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
    User user = mapper.checkLogin("admin", "123456");
    System.out.println(user);
}

3、map集合类型的参数

若mapper接口中的方法需要的参数为多个时，此时可以手动创建map集合，将这些数据放在map中，只需要通过${}和#{}访问map集合的键就可以获取相对应的值，注意${}需要手动加单引号。

1）实现验证登录(参数为map)的功能：

在mapper接口文件ParamererMapper.java中配置：

//验证登录(参数为map)
User checkLoginByMap(Map<String, Object> map);

2）在mapper映射文件ParameterMapper.xml中关联mapper接口文件：

<!--实现验证登录(参数为map)的功能。将该SQL语句的方法与mapper接口中checkLoginByMap(Map<String, Object> map)方法关联-->
<select id="checkLoginByMap" resultType="User">
    <!--此时#{}和${}中的名称以自己定义的map的key为准-->
    <!--select * from t_user where username = #{username} and password = #{password}-->
    select * from t_user where username = '${username}' and password = '${password}'
</select>

3）在TestParameterMapper.java测试类中编写测试方法：

/**
* MyBatis获取参数值的两种方式：${}和#{}
* ${}本质是字符串拼接
* #{}本质是占位符赋值
* 能用#{}就不用$[}，因为${}会引起sql注入
*
* MyBatis获取参数值的各种情况：
*   1.mapper接口方法的参数为单个的字面量类型：
*     可以通过${}和#{}以任意的名称获取参数值，但是需要注意${}的单引号问题
*   2.mapper接口方法的参数为多个字面量类型：
*     此时MyBatis会将这些参数放在一个map集合中以两种方式进行存储：
*       a>以arg0，arg1，...为key，以参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*   3、若mapper接口方法的参数有多个时，可以手动将这些参数放在一个map中来存储：
*     此时只需要通过#{}和${}以键的方式来访问值即可，而#{}和${}中的名称以自己定义的
*     map的key为准但是需要注意${}的单引号问题
*   4、mapper接口方法的参数为实体类类型：
*     只需要通过#{}和${}以实体类中属性名的方式访问属性值即可，但是要注意${}的单引号问题
*   5、使用@Param注解命名参数：
*     此时MyBatis会将这些参数放在一个map集合中，以两种方式进行存储：
*       a>以@Param注解中的值为key，以之后的参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*/
//测试验证登录(参数为map)的功能
@Test
public void testCheckLoginByMap(){
    SqlSession sqlSession = SqlSessionUtils.getSqlSession();
    ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("username", "admin");
    map.put("password", "123456");
    User user = mapper.checkLoginByMap(map);
    System.out.println(user);
}

4、实体类类型的参数

可以使用#{}和${}直接通过实体类中的属性名获取属性值。是实际用到的最多的情况之一。

1）实现添加用户信息的功能：

在mapper接口文件ParamererMapper.java中配置：

//添加用户信息
int insertUser(User user);

2）在mapper映射文件ParameterMapper.xml中关联mapper接口文件：

<!--实现添加用户信息的功能。将该SQL语句的方法与mapper接口中insertUser(User user)方法关联-->
<insert id="insertUser">
    <!--使用#{}和${}直接通过实体类中的属性名获取属性值-->
    insert into t_user values(null, #{username}, #{password}, #{age}, #{sex}, #{email})
</insert>

3）在TestParameterMapper.java测试类中编写测试方法：

/**
* MyBatis获取参数值的两种方式：${}和#{}
* ${}本质是字符串拼接
* #{}本质是占位符赋值
* 能用#{}就不用$[}，因为${}会引起sql注入
*
* MyBatis获取参数值的各种情况：
*   1.mapper接口方法的参数为单个的字面量类型：
*     可以通过${}和#{}以任意的名称获取参数值，但是需要注意${}的单引号问题
*   2.mapper接口方法的参数为多个字面量类型：
*     此时MyBatis会将这些参数放在一个map集合中以两种方式进行存储：
*       a>以arg0，arg1，...为key，以参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*   3、若mapper接口方法的参数有多个时，可以手动将这些参数放在一个map中来存储：
*     此时只需要通过#{}和${}以键的方式来访问值即可，而#{}和${}中的名称以自己定义的
*     map的key为准但是需要注意${}的单引号问题
*   4、mapper接口方法的参数为实体类类型：
*     只需要通过#{}和${}以实体类中属性名的方式访问属性值即可，但是要注意${}的单引号问题
*   5、使用@Param注解命名参数：
*     此时MyBatis会将这些参数放在一个map集合中，以两种方式进行存储：
*       a>以@Param注解中的值为key，以之后的参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*/
//测试添加用户信息的功能
@Test
public void testInsertUser(){
    SqlSession sqlSession = SqlSessionUtils.getSqlSession();
    ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
    int result = mapper.insertUser(new User(null, "李四", "123", 23, "男", "123@qq.com"));
    System.out.println(result);
}

5、@Param注解命名参数

此时MyBatis会将这些参数放在一个map集合中，以两种方式进行存储：以@Param注解中的值为key，以之后的参数为value；或者以param1，param2，...为key，以参数为value。因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题。也是实际用到的最多的情况之一。

1）实现验证登录(使用@Param注解)的功能：

在mapper接口文件ParamererMapper.java中配置：

//验证登录(使用@Param注解)
/**
 * 使用@param注解后，MyBatis会将参数放入map集合，然后以@Param
 * 注解中的值为key，以之后的参数为value
 */
User checkLoginByParam(@Param("username") String username, @Param("password") String password);

2）在mapper映射文件ParameterMapper.xml中关联mapper接口文件：

<!--
    实现验证登录(使用@Param注解)的功能。将该SQL语句的方法与mapper接口中
    checkLoginByParam(@Param("username") String username, @Param("password") String password)方法关联
-->
<select id="checkLoginByParam" resultType="User">
    select * from t_user where username = #{username} and password = #{password}
</select>

3）在TestParameterMapper.java测试类中编写测试方法：

/**
* MyBatis获取参数值的两种方式：${}和#{}
* ${}本质是字符串拼接
* #{}本质是占位符赋值
* 能用#{}就不用$[}，因为${}会引起sql注入
*
* MyBatis获取参数值的各种情况：
*   1.mapper接口方法的参数为单个的字面量类型：
*     可以通过${}和#{}以任意的名称获取参数值，但是需要注意${}的单引号问题
*   2.mapper接口方法的参数为多个字面量类型：
*     此时MyBatis会将这些参数放在一个map集合中以两种方式进行存储：
*       a>以arg0，arg1，...为key，以参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*   3、若mapper接口方法的参数有多个时，可以手动将这些参数放在一个map中来存储：
*     此时只需要通过#{}和${}以键的方式来访问值即可，而#{}和${}中的名称以自己定义的
*     map的key为准但是需要注意${}的单引号问题
*   4、mapper接口方法的参数为实体类类型：
*     只需要通过#{}和${}以实体类中属性名的方式访问属性值即可，但是要注意${}的单引号问题
*   5、使用@Param注解命名参数：
*     此时MyBatis会将这些参数放在一个map集合中，以两种方式进行存储：
*       a>以@Param注解中的值为key，以之后的参数为value
*       b>以param1，param2，...为key，以参数为value
*     因此只需要通过#{}和${}以键的方式来访问值即可，但是需要注意${}的单引号问题
*/
//测试验证登录(使用@Param注解)的功能
@Test
public void testCheckLoginByParam(){
    SqlSession sqlSession = SqlSessionUtils.getSqlSession();
    ParameterMapper mapper = sqlSession.getMapper(ParameterMapper.class);
    User user = mapper.checkLoginByParam("admin", "123456");
    System.out.println(user);
}

6、多种获取参数值方式的总结

获取参数值方式有五种，但其实可以将其总结为两类：

• 使用实体类获取参数值

• 使用@Param获取参数值

这样不管是获取单个参数值还是多个参数值时，都可以解决问题。