Mybatis(11) —— 使用注解开发

1.面向接口编程

    根本原因：解耦，可扩展、提高复用、在分层开发中上层设计和底层实现分离(即上层不用管底层的实现)，大家都遵守共同的标准，使得开发变得容易，规范性好

• 在一个面向对象的系统中，系统的各种功能是由许许多多的不同对象协作完成的。在这种情况下，各个对象内部是如何实现自己的,对系统设计人员来讲就不那么重要了；
• 而各个对象之间的协作关系则成为系统设计的关键。小到不同类之间的通信，大到各模块之间的交互，在系统设计之初都是要着重考虑的，这也是系统设计的主要工作内容。面向接口编程就是指按照这种思想来编程

关于接口的理解

• 接口从更深层次的理解，应是定义（规范，约束）与实现（名实分离的原则）的分离。
• 接口的本身反映了系统设计人员对系统的抽象理解。
• 接口应有两类：
  • 第一类是对一个个体的抽象，它可对应为一个抽象体(abstract class)；
  • 第二类是对一个个体某一方面的抽象，即形成一个抽象面（interface）；
• 一个体有可能有多个抽象面，抽象体与抽象面是有区别的

3个面向的区别

• 面向对象是指，我们考虑问题时，以对象为单位，考虑它的属性及方法
• 面向过程是指，我们考虑问题时，以一个具体的流程（事务过程）为单位，考虑它的实现
• 接口设计与非接口设计是针对复用技术而言的，与面向对象（过程）不是一个问题，它更多体现的就是对系统整体的架构

---

2.使用注解开发

    上图就是mybatis官方文档对于使用注解开发的说明，我们需要从中理解到以下几点

• 对于SQL语句在mybatis核心文件中的映射，我们除了使用mapper.xml文件之外，还可以使用Java注解来实现
• 使用注解来映射简单语句会使代码显得更加简洁
• 但对于稍微复杂一点的语句，Java 注解不仅力不从心，还会让你本就复杂的 SQL 语句更加混乱不堪， 因此，如果你需要做一些很复杂的操作，最好用 XML 来映射语句
• 永远不要拘泥于一种方式，你可以很轻松的在基于注解和 XML 的语句映射方式间自由移植和切换

实际操作

    创建一个新model，mybatis-05，复制粘贴mybatis-04中的文件，测试model是否搭建成功

    对于上面的输出有点乱，我们把log4j删除，直接使用标准日志输出来查看，前面官方文件上也说了，可以不使用mapper.xml文件了，那我们就把UserMapper.xml也删除

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!--引入外部配置文件-->
    <properties resource="db.properties">
        <property name="username" value="root"/>
        <property name="password" value="123"/>
    </properties>
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
    <typeAliases>
        <package name="com.thhh.pojo"/>
    </typeAliases>

    <!--数据库环境节点-->
    <environments default="development"><!--environments节点的default属性指定配置的众多环境中默认使用哪一个数据库环境-->
        <!--环境1，我们还可以配置其他很多的环境节点-->
        <environment id="development">
            <transactionManager type="JDBC"/><!--事务管理，这里使用的就是JDBC中的事务管理-->
            <dataSource type="POOLED">
                <!--属性节点，name设置属性名称，value设置属性值-->
                <!--这里配置的就是JDBC4大参数-->
                <property name="driver" value="${driver}"/><!--驱动-->
                <!--注意：在XML中使不能直接使用&连接参数，我们需要转义，使用&amp;代替&-->
                <property name="url" value="${url}"/><!--数据库的URL-->
                <property name="username" value="${username}"/><!--连接数据库的账号-->
                <property name="password" value="${password}"/><!--连接数据库的密码-->
            </dataSource>
        </environment>
    </environments>
<!--    <mappers>
        <mapper class="com.thhh.dao.UserMapper"/>
    </mappers>-->
    
</configuration>

• 在接口上编写注解

package com.thhh.dao;

import com.thhh.pojo.User;
import org.apache.ibatis.annotations.Select;

//在mybatis中，我们一般不写dao，而将其改写为mapper，其实二者是一样的，只是名字变了
public interface UserMapper {
    @Select("Select * from user")
    User getUserList(int id);
}

• mybatis核心配置文件中映射SQL语句

    <mappers>
        <mapper class="com.thhh.dao.UserMapper"/>
    </mappers>

注意：现在由于没有了mapper.xml，所有现在映射SQL语句就只能依靠class或包扫描，这里使用的是class映射

• 测试

package com.thhh.dao;

import com.thhh.pojo.User;
import com.thhh.utils.MyBatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.apache.log4j.Logger;
import org.junit.Test;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class UserDaoTest {
    static Logger logger = Logger.getLogger(UserDaoTest.class);

    @Test
    public void testGetUserByRowbounds(){
        //1、获取SqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = mapper.getUserList();
        for (User user : userList) {
            System.out.println(user);
        }
        sqlSession.close();
    }
}

    但是我们还是需要注意一下，使用注解查询出来的这个结果并不规范，因为password属性为null，原因就是我们在学习resultMap的时候将实体类User的pwd属性修改为了password，这就使得实体类的属性名称和数据表中的字段名称不一样，原来使用mapper.xml文件的时候，我们还可以通过设置resultMap来实现映射，现在使用注解，就不能使用resultMap了，所以官方文档才说复杂的操作还是推荐我们使用mapper.xml实现SQL语句的映射

---

3、使用注解实现CRUD

    首先我们修改一下工具类MyBatisUtils的代码，主要就是sqlSessionFactory的openSession()的参数

public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession(true);
    }

• 查询
  • 接口定义

    package com.thhh.dao;
    
    import com.thhh.pojo.User;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    
    import java.util.List;
    
    //在mybatis中，我们一般不写dao，而将其改写为mapper，其实二者是一样的，只是名字变了
    public interface UserMapper {
        @Select("Select * from user")
        List<User> getUserList();
        @Select("select * from user where id = #{id}")
        User getUserById(@Param("id") int id);
    }
    

    注意：使用注解开发的时候，只要有参数，我们就需要在它的前面加上一个"**@Param(“属性值”)"**的注解，虽然只有一个参数的时候可以不加，但是为了规范和习惯，推荐只要有参数，我们都把参数写上

• 测试

  package com.thhh.dao;
  
  import com.thhh.pojo.User;
  import com.thhh.utils.MyBatisUtils;
  import org.apache.ibatis.session.SqlSession;
  import org.apache.log4j.Logger;
  import org.junit.Test;
  
  public class UserDaoTest {
      static Logger logger = Logger.getLogger(UserDaoTest.class);
  
      @Test
      public void testGetUserById(){
          //1、获取SqlSession对象
          SqlSession sqlSession = MyBatisUtils.getSqlSession();
          UserMapper mapper = sqlSession.getMapper(UserMapper.class);
          User user = mapper.getUserById(2);
          System.out.println(user);
          sqlSession.close();
      }
  }
  

    通过对比，我们可以发现，SQL去参数值的时候是去取注解中的那个参数，而不是我们定义的方法中的那个参数

• 新增
  • 接口定义

    package com.thhh.dao;
    
    import com.thhh.pojo.User;
    import org.apache.ibatis.annotations.Insert;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    
    import java.util.List;
    
    //在mybatis中，我们一般不写dao，而将其改写为mapper，其实二者是一样的，只是名字变了
    public interface UserMapper {
        //1、查询所有用户
        @Select("Select * from user")
        List<User> getUserList();
    
        //2、按照id查询用户
        @Select("select * from user where id = #{id}")
        User getUserById(@Param("id") int id);
    
        //3、新增用户
        @Insert("insert into user(id,name,pwd) values(#{id},#{name},#{password})")
        int addUser(User user);
    }
    

  • 测试

        @Test
        public void testAddUser(){
            //1、获取SqlSession对象
            SqlSession sqlSession = MyBatisUtils.getSqlSession();
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            int result = mapper.addUser(new User(8,"赵八","123"));
            System.out.println("数据库受影响行数 = "+result);
            sqlSession.close();
        }
    

    注意：上面我们并没有显式的提交事务，但是由测试结果我们可以发现，数据已经持久化到了数据库中，原因就是我们前面向openSession()中传入参数true，这就使得这个sqlsession对象会自动的提交事务

• 修改
  • 接口

    package com.thhh.dao;
    
    import com.thhh.pojo.User;
    import org.apache.ibatis.annotations.Insert;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    import org.apache.ibatis.annotations.Update;
    
    import java.util.List;
    
    //在mybatis中，我们一般不写dao，而将其改写为mapper，其实二者是一样的，只是名字变了
    public interface UserMapper {
        //1、查询所有用户
        @Select("Select * from user")
        List<User> getUserList();
    
        //2、按照id查询用户
        @Select("select * from user where id = #{id}")
        User getUserById(@Param("id") int id);
    
        //3、新增用户
        @Insert("insert into user(id,name,pwd) values(#{id},#{name},#{password})")
        int addUser(User user);
    
        //4、修改用户信息
        @Update("update user set name = #{name},pwd = #{password} where id = #{id}")
        int updateUser(User user);
    }
    

  • 测试

        @Test
        public void testUpdateUser(){
            SqlSession sqlSession = MyBatisUtils.getSqlSession();
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            mapper.updateUser(new User(2,"李四","123"));
            sqlSession.close();
        }
    

• 删除
  • 接口

    package com.thhh.dao;
    
    import com.thhh.pojo.User;
    import org.apache.ibatis.annotations.*;
    
    import java.util.List;
    
    //在mybatis中，我们一般不写dao，而将其改写为mapper，其实二者是一样的，只是名字变了
    public interface UserMapper {
        //1、查询所有用户
        @Select("Select * from user")
        List<User> getUserList();
    
        //2、按照id查询用户
        @Select("select * from user where id = #{id}")
        User getUserById(@Param("id") int id);
    
        //3、新增用户
        @Insert("insert into user(id,name,pwd) values(#{id},#{name},#{password})")
        int addUser(User user);
    
        //4、修改用户信息
        @Update("update user set name = #{name},pwd = #{password} where id = #{id}")
        int updateUser(User user);
    
        //5、删除用户
        @Delete("delete from user where id = #{id}")
        int deleteUser(int id);
    }
    

  • 测试

        @Test
        public void testDeleteUser(){
            SqlSession sqlSession = MyBatisUtils.getSqlSession();
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            mapper.deleteUser(8);
            sqlSession.close();
        }
    

---

4.回顾

---

5.小结

• 我们的sqlsession的事务可以设置自动提交，但是我们不推荐这么做，否则当我们的代码有错的时候它也提交了事务
• 通过注解可以实现CRUD
• 注解只适合与简单的SQL操作
• 注解中可以获取方法中的参数，如果方法只有一个参数，我们可以不在参数列表前面写@Param(“参数名称”)，但是一旦参数超过一个，我们就必须在每个参数前面加上@Param(“参数名称”)，且SQL中取的参数名称必须和@Param(“参数名称”)参数名称保持一致，否则将报错，而方法的参数可以随意写
• 使用XML实现CRUD有3步：接口编写、mapper.xml编写和测试
• 使用注解实现CRUD有2步：接口编写和测试(前提是我们已经在mybatis的核心配置文件中注册了这个接口)

---

关于@Param()注解

• 基本数据类型和String作为参数的时候应该在前面加上@Param()注解
• 引用数据类型不用加上@Param()
• 如果只有一个基本数据类型，可以不加@Param()，但是还是建议加上
• 我们在SQL语句中引用的就是我们在@Param()中设置的属性名

---

补充：#{} 和 ${}的区别(引自: link.)

• MyBatis中使用parameterType向SQL语句传参，parameterType后的类型可以是基本类型int,String,HashMap和java自定义类型。

• 在SQL中引用这些参数的时候，可以使用两种方式#{parameterName}或者${parameterName}。

• 区别

  • #{}：#将传入的数据都当成一个字符串，会对自动传入的数据加一个双引号

    • 例如：order by #{parameterName} //或取Map中的value#{Key}也是一样操作
      • 假设传入参数是“Smith”，会解析成：order by “Smith”

  • $ {}：$将传入的数据直接显示生成在sql中

    • 例如：order by #{parameterName} //或取Map中的value#{Key}也是一样操作。
      • 假设传入参数是“Smith”，会解析成：order by Smith

• 概念

  • #方式能够很大程度防止sql注入，$方式无法防止Sql注入。
  • $方式一般用于传入数据库对象，例如传入表名。
  • 从安全性上考虑，能使用#尽量使用#来传参，因为这样可以有效防止SQL注入的问题

• 重点

  • MyBatis排序时使用order by 动态参数时需要注意，用$而不是#！