MyBatis笔记----MyBatis 入门经典的两个例子： XML 定义与注解定义

Posted 2020-09-07 Stay Hungry, Stay Foolish

----致敬MyBatis官方开放文档让大家翻译，不用看书直接看文档就行了，mybatis的中文文档还需要完备的地方

 

 

 

 

 

 

 

 

简介

什么是 MyBatis ？

MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以对配置和原生Map使用简单的 XML 或注解，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

---

 mysql数据库

CREATE DATABASE mybatis;
USE mybatis;
CREATE TABLE users(
id INT PRIMARY KEY AUTO_INCREMENT,
NAME VARCHAR(25),
age INT
)
INSERT INTO users(NAME,age) VALUES("林彪",26);
INSERT INTO users(NAME,age) VALUES("平头哥",33);
INSERT INTO users(NAME,age) VALUES("小明",49);
INSERT INTO users(NAME,age) VALUES("二哥",26);
INSERT INTO users(NAME,age) VALUES("纹身哥",56);
INSERT INTO users(NAME,age) VALUES("大力哥",13);
INSERT INTO users(NAME,age) VALUES("大B",23),("小A",45),("李白",32);

---

 

XML 定义

 

结构

 

 

 

---

 User.java

package com.ij34.model;

public class User {
  private int id;
  private String name;
  private int age;

  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 int getAge() {
    return age;
}

public void setAge(int age) {
    this.age = age;
}

public String toString() {
     return "User [id=" + id + ", name=" + name + ", age=" + age + "]";
}


}

View Code

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.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mybatis?seSSL=true"/>
        <property name="username" value="root"/>
        <property name="password" value="123456"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
  <mapper resource="com/ij34/mybatis/UserMapper.xml"/>
  </mappers>
</configuration>

 

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">
<mapper namespace="com.ij34.mybatis.UserMapper">
  <select id="selectUser" parameterType="int" resultType="com.ij34.model.User">
    select * from users where id = #{id}
  </select>
</mapper>

 

---

Test.java

package com.ij34.bean;

import java.io.IOException;
import java.io.InputStream;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import com.ij34.model.User;
public class Test {
public static void main(String[] args) throws IOException {
    String resource = "com/ij34/mybatis/mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
   SqlSession session=sqlSessionFactory.openSession();
   try {
        User user=session.selectOne("com.ij34.mybatis.UserMapper.selectUser", 1); //对应于UserMapper.xml选择id名selectUser

          // UserMapper mapper=session.getMapper(UserMapper.class);
         // User user=mapper.selectUser(1);

        System.out.println(user);

} finally {
    // TODO: handle finally clause
   session.close();
}
}
}

---

 

结果

 

 

 

 

---

---

---

---

---

 

注解定义

下面

还有另一招来处理，它们的映射的语句可以不需要用 XML 来做，取而代之的是可以使用 Java 注解。

比如，上面的 UserMapper.xml 可被替换如下：

package com.ij34.model;

import org.apache.ibatis.annotations.Select;

public interface UserMapper {
      @Select("select * from users where id= #{id}")
  public User selectUser(int id);
}

 

---

mybatis-config.xml

  <mapper resource="com/ij34/mybatis/UserMapper.xml"/>

替换成

<mapper class="com.ij34.model.UserMapper"/>

---

Test.java

User user=session.selectOne("com.ij34.mybatis.UserMapper.selectUser", 1); 

替换成

  UserMapper mapper=session.getMapper(UserMapper.class); 
  User user=mapper.selectUser(1);

 

 第二种方法有很多优势，首先它不是基于字符串常量的，就会更安全；其次，如果你的 IDE 有代码补全功能，那么你可以在有了已映射 SQL 语句的基础之上利用这个功能。

 

---

 

其他知识 

：

命名空间（Namespaces）在之前版本的 MyBatis 中是可选的，容易引起混淆因此是没有益处的。现在的命名空间则是必须的，目的是希望能比只是简单的使用更长的完全限定名来区分语句更进一步。

命名解析：为了减少输入量，MyBatis 对所有的命名配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。

 

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但是最好还是不要让其一直存在以保证所有的 XML 解析资源开放给更重要的事情。

SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由对它进行清除或重建。使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏味道（bad smell）”。因此 SqlSessionFactory 的最佳作用域是应用作用域。有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。也绝不能将 SqlSession 实例的引用放在任何类型的管理作用域中，比如 Serlvet 架构中的 HttpSession。如果你现在正在使用一种 Web 框架，要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。换句话说，每次收到的 HTTP 请求，就可以打开一个 SqlSession，返回一个响应，就关闭它。这个关闭操作是很重要的，你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。

映射器实例（Mapper Instances）

映射器是创建用来绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。因此从技术层面讲，映射器实例的最大作用域是和 SqlSession 相同的，因为它们都是从 SqlSession 里被请求的。尽管如此，映射器实例的最佳作用域是方法作用域。也就是说，映射器实例应该在调用它们的方法中被请求，用过之后即可废弃。并不需要显式地关闭映射器实例，尽管在整个请求作用域（request scope）保持映射器实例也不会有什么问题，但是很快你会发现，像 SqlSession 一样，在这个作用域上管理太多的资源的话会难于控制。所以要保持简单，最好把映射器放在方法作用域（method scope）内。