Mybatis學習-初步認知與使用

Mybatis是一款優秀的持久層框架。且支持定制化SQL，存儲過程以及高級映射
Mybatis幾乎免除了所有的JDBC代碼以及設置參數和獲取結果集的工作，它使用簡單的XML或注解來配置原始類型、接口和將數據庫中的記錄映射成POJO（Plain Old Java Objects，普通老式java對象）

為什么需要Mybatis：方便；傳統的JDBC代碼太復雜了，簡化程序員編寫與數據庫實現交互的代碼的過程

優點：

• 簡單易學
• 靈活
• SQL與代碼分離，提高了可維護性
• 提供映射標簽，支持對象與數據庫的ORM字段關系映射
• 提供對象關系映射標簽，支持對象關系組件維護
• 提供XML標簽，支持編寫動態SQL

第一個Mybatis程序

搭建數據庫

CREATE TABLE user (
        id INT(20) NOT NULL,
	name VARCHAR(30) DEFAULT NULL,
	pwd VARCHAR(30) DEFAULT NULL,
	PRIMARY KEY (id)
)

在項目中創建一個模塊Mybatis01

1. 編寫Mybatis的核心配置文件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>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Drive"/>
                <property name="url" value="jdbc:mysql://localhost:3306/learn?serverTimezone=GMT&amp;useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="rooot "/>
                <property name="password" value="123456789"/>
            </dataSource>
        </environment>
    </environments>

    <!--每一個Mapper.xml都需要在Mybatis核心配置文件中注冊-->
    <mappers>
        <!--UserMapper.xml文件放在resource的mapper文件夾中-->
        <mapper resource="mapper/UerMapper.xml"/>
    </mappers>
</configuration>

2. 編寫Mybatis工具類

/**
 * mybatis的sqlsessionfactory工具類，獲取sqlSessionFactory對象
 * Created by 羅星
 * 2020/11/19 0019 20:16
 */
public class MybatisUtil {

    private static SqlSessionFactory sqlSessionFactory;
    
    static {
        InputStream inputStream = null;
        try {
            String resource = "mybatis-config.xml";
            inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }

    }
    
    //獲取Sqlsession實例
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
        //設置自動提交
        //return sqlSessionFactory.openSession(true);  
    }

}

3. 編寫項目代碼

• 實體類

public class User {

    private int id;

    private String name;

    private String pwd;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + pwd + '\'' +
                '}';
    }
}

• DAO接口

public interface UserDao {
    List<User> getUserList();
}

• 接口實現。由原來的Impl類轉換為一個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">
<!--namespace綁定一個對應的Dao/Mapper接口-->
<mapper namespace="com.luoqing.dao.UserMapper">
    <!--id是需要重寫方法的名字-->
    <select id="getUserList" resultType="com.luoqing.model.User">
    select * from learn.user
  </select>
</mapper>

Mapper.xml需要放在resource文件夾中才能被掃描到。如果需要放在java文件夾中則需要在主pom.xml文件中添加以下配置

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

• 測試

public class UserDaoTest {
    
    @Test
    public void test() {
        //獲取SQLSession對象
        SqlSession sqlSession = MybatisUtil.getSqlSession();

        try {
            
            //方式一：getMapper
            UserDao mapper = sqlSession.getMapper(UserDao.class);
            List<User> userList = mapper.getUserList();

            //方式二：
            //List<User> userList = sqlSession.selectList("com.luoqing.dao.UserDao.getUserList");

            for (User user : userList) {
                System.out.println(user);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            //關閉SQLSession
            sqlSession.close();
        }
    }
}

可能遇到的問題：

• 配置文件沒有注冊：所有的Mapper.xml文件都需要在mybatis-config.xml文件中的mappers標簽中注冊
• 綁定接口錯誤：Mapper.xml的namespace屬性的值需要准確對應接口的路徑的名字

CRUD

實現步驟

1. 在Mapper接口中添加方法
2. 在Mapper.xml中添加對應標簽及SQL語句
3. 編寫實現代碼

1. select

接口

public interface UserMapper {
    //根據ID查詢用戶
    User getUserById(int id);
}

Mapper.xml

<mapper namespace="com.luoqing.dao.UserMapper">
    <!--parameterType：參數類型-->
    <!--resultType：SQL語句執行的返回值-->
    <select id="getUserById" parameterType="int" resultType="com.luoqing.model.User">
    	<!--只有一個基本類型參數的情況下，可以在SQL中使用#{}獲取到-->
        select * from learn.user where id = #{id}	
	</select>
</mapper>

測試

@Test
public void getUserByIdTest() {
      SqlSession sqlSession = MybatisUtil.getSqlSession();

      UserMapper mapper = sqlSession.getMapper(UserMapper.class);

      User userById = mapper.getUserById(1);

      System.out.println(userById);

      sqlSession.close();
}

2. insert

接口

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

Mapper.xml

<insert id="addUser" parameterType="com.luoqing.model.User">
    <!--參數為自定義對象時，可以直接使用#{屬性名}獲取-->	
    insert into learn.user(id, name, pwd) values (#{id}, #{name}, #{pwd})
</insert>

測試

@Test
public void addUserTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();

    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    int luoxing = mapper.addUser(new User(4, "luoxing", "12345"));

    if (luoxing > 0) {
        System.out.println("success");
    }

    //提交事務
    sqlSession.commit();

    sqlSession.close();
}

3. update

接口

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

Mapper.xml

<update id="updateUser" parameterType="com.luoqing.model.User">
        update learn.user set name=#{name},pwd=#{pwd} where id = #{id}
</update>

測試

@Test
public void updateUserTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();

    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    mapper.updateUser(new User(4, "yellow" , "12313"));

    //提交事務
    sqlSession.commit();

    sqlSession.close();
}

4. delete

接口

public interface UserMapper {
    int deleteUser(int id);
}

Mapper.xml

<delete id="deleteUser" parameterType="int">
        delete from learn.user where id = #{id}
</delete>

測試

@Test
public void deleteUserTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    mapper.deleteUser(4);

    sqlSession.commit();

    sqlSession.close();
}

5. 模糊查詢

1. java代碼傳遞參數時，添加通配符，防止SQL注入

List<User> userList = mapper.getUserList("%李%");

2. 在SQL拼接中使用通配符，防止SQL注入

<select id="getUserList" parameterType="String" resultType="com.luoqing.model.User">
    select * from learn.user where name like "%"#{value}"%"
</select>

可能存在的問題：

• 關於事務提交：增刪改一定要提交事務，否則修改無法上傳

好用的工具-Map

假設我們的實體類或者數據庫中的表字段或者參數過多，我們可以使用map減少工作量。使用map可以隨意控制屬性的名稱和數量
map傳遞參數直接在SQL中使用#{Key}取出即可

1. 編寫接口

public interface UserMapper {
    //添加一條記錄
    int addUser2(Map<String, Object> map);
}

2. Mapper.xml

<insert id="addUser2" parameterType="map">
        insert into learn.user(id, name, pwd) values (#{userId}, #{userName})
</insert>

3. 測試

@Test
public void addUser2Test() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    HashMap<String, Object> map = new HashMap<String, Object>();

    //map中的key可以隨意
    map.put("userId", 4);
    map.put("userName", "luoxing");
    //數據庫中password默認為null，我們這里不進行賦值     

    mapper.addUser2(map);

    sqlSession.commit();

    sqlSession.close();

}

在上面的例子中，我們使用map給User表中新添加了一行數據，只需要將需要使用的字段添加進去就行了。如果使用的是實體類傳參，要不就是給User類添加一個只有id和name的新的構造方法，要不就是給password賦值為null，當實體類有幾十個或者上百個屬性的時候，工作量會大到幾乎不可能完成