Mybatis - 入门

时间  2021-04-02
标签 html java mysql sql 数据库 安全 session mybatis 架构 并发 栏目 MyBatis 繁體版
原文   原文链接

1. 入门

1.1 引JAR包

要使用mybatis，只需将mybatis-x.x.x.jar，文件置于classpath中便可。html

若是使用maven来构建项目，则须要将dependency代码置于pom.xml文件中：java

<dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis</artifactId>
   <version>3.4.4</version>
  </dependency>

1.2 从XML中构建SQLSessionFactory

每一个基于 MyBatis 的应用都是以一个SqlSessionFactory的实例为中心的。SqlSessionFactory的实例能够经过 SqlSessionFactoryBuilder得到。而SqlSessionFactoryBuilder则能够从XML配置文件或一个预先定制的Configuration的实例构建出SqlSessionFactory的实例。mysql

从 XML 文件中构建 SqlSessionFactory 的实例很是简单，建议使用类路径下的资源文件进行配置。可是也可使用任意的输入流(InputStream)实例，包括字符串形式的文件路径或者 file:// 的 URL 形式的文件路径来配置。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，可以使从 classpath 或其余位置加载资源文件更加容易。sql

String resource = "mybatis-config.xml";
InputStream is = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);

XML 配置文件（configuration XML）中包含了对 MyBatis 系统的核心设置，包含获取数据库链接实例的数据源（DataSource）和决定事务做用域和控制方式的事务管理器（TransactionManager）。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://192.168.25.84:3306/test"/>
        <property name="username" value="root"/>
        <property name="password" value="mysql"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/mapper/UserMapper.xml"/>
  </mappers>
</configuration>

固然，还有不少能够在XML 文件中进行配置，上面的示例指出的则是最关键的部分。要注意 XML 头部的声明，用来验证 XML 文档正确性。environment 元素体中包含了事务管理和链接池的配置。mappers 元素则是包含一组 mapper 映射器（这些 mapper 的 XML 文件包含了 SQL 代码和映射定义信息）。　　安全

1.3 从SqlSessionFactory中获取SqlSession

既然有了 SqlSessionFactory ，顾名思义，咱们就能够从中得到 SqlSession 的实例了。SqlSession 彻底包含了面向数据库执行 SQL 命令所需的全部方法。你能够经过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：session

SqlSession session = sqlSessionFactory.openSession();
        try {
            UserMapper mapper = session.getMapper(UserMapper.class);
            User user = mapper.selectUser(1);
            User u = session.selectOne("org.mybatis.mapper.UserMapper.selectUser", 2); 旧版本的使用方式
            System.out.println(user.getUser_name());
            System.out.println(u.getUser_name());
        } finally {
            session.close();
        }

1.4 映射SQL语句

MyBatis 提供的所有特性能够利用基于 XML 的映射语言来实现。mybatis

<?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="org.mybatis.mapper.UserMapper">
  <select id="selectUser" resultType="org.mybatis.mapper.User">
    select * from user where id = #{id}
  </select>
</mapper>

在一个 XML 映射文件中，你想定义多少个映射语句都是能够的。架构

在命名空间org.mybatis.mapper.UserMapper中定义一个名为selectUser的映射语句，这样就容许你使用指定的彻底限定名org.mybatis.mapper.UserMapper.selectUser来调用映射语句。并发

对于像UserMapper这样的映射器类来讲，还有另外一处理方法，他们的映射语句能够不须要用XML来作，取而代之的可使用Java注解。好比，上面XML可被替换为：

package org.mybatis.mapper;
public interface UserMapper {
  @Select("SELECT * FROM userWHERE id = #{id}")
  User selectUser(int id);
}

对于简单语句来讲，注解使代码显得更加简洁，然而 Java 注解对于稍微复杂的语句就会力不从心而且会显得更加混乱。所以，若是你须要作很复杂的事情，那么最好使用 XML 来映射语句。　　

选择何种方式以及映射语句的定义的一致性对你来讲有多重要这些彻底取决于你和你的团队。换句话说，永远不要拘泥于一种方式，你能够很轻松的在基于注解和 XML 的语句映射方式间自由移植和切换。

1.5 做用域（scope）和生命周期

理解咱们目前已经讨论过的不一样做用域和生命周期类是相当重要的，由于错误的使用会致使很是严重的并发问题。　

依赖注入框架能够建立线程安全的，基于事务的SqlSession和映射器并将他们直接注入到你的bean中，所以能够直接忽略他们的生命周期。

1.5.1 SqlSessionFactoryBuilder

这个类能够被实例化、使用和丢弃，一旦建立了SqlSessionFactory，就不在须要它了。所以SqlSessionFactoryBuilder实例的最佳做用域是方法做用域（也就是局部方法变量）。能够重用SqlSessionFactoryBuilder来建立多个SqlSessionFactory实例，可是最好仍是不要让其一直存在以保证全部的XML解析资源开放给更重要的事情。

1.5.2 SqlSessionFactory

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

1.5.3 SqlSession

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

SqlSession session = sqlSessionFactory.openSession();
try {
  // do work
} finally {
  session.close();
}

在你的全部的代码中一致性地使用这种模式来保证全部数据库资源都能被正确地关闭。　　

1.5.4 映射器实例(Mapper Instances)

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

SqlSession session = sqlSessionFactory.openSession();
try {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // do work
} finally {
  session.close();
}

2. demo

2.1 建立maven工程

pom.xml文件添加以下依赖：

<dependencies>
  <dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis</artifactId>
   <version>3.4.4</version>
  </dependency>
  <dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <version>5.1.36</version>
  </dependency>

 </dependencies>

2.2 建立工程目录结构

如图

其中

（1）App.java是业务运行主类；

public class App {
    public static void main(String[] args) throws IOException {
        String resource = "mybatis-config.xml";
        InputStream is = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        SqlSession session = sqlSessionFactory.openSession();
        try {
            UserMapper mapper = session.getMapper(UserMapper.class);
            User user = mapper.selectUser(1);
            User u = session.selectOne("org.mybatis.mapper.UserMapper.selectUser", 2);
            System.out.println(user.getUser_name());
            System.out.println(u.getUser_name());
        } finally {
            session.close();
        }
    }
}

　　

（2）User.java与数据库映射的实体类；

public class User {
    private int id;
    private String user_name;
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getUser_name() {
        return user_name;
    }
    public void setUser_name(String user_name) {
        this.user_name = user_name;
    } 
    
}　　

其中，数据库中表user的结构和数据以下：

 

 

（3）UserMapper.java映射器接口；

public interface UserMapper {
 
    User selectUser(int id);
}

　　

（4）UserMapper.xml映射器的sql定义等；

<?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="org.mybatis.mapper.UserMapper">
  <select id="selectUser" resultType="org.mybatis.mapper.User">
    select * from user where id = #{id}
  </select>
</mapper>

（5）mybatis-config.xml引入的mybatis的基本配置，注意：与包是同级的；

<?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://192.168.25.84:3306/test"/>
        <property name="username" value="root"/>
        <property name="password" value="mysql"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/mapper/UserMapper.xml"/>
  </mappers>
</configuration>

2.3 运行及结果

当成正常的java工程运行，运行App.java类，运行结果以下：

x. 参考资料

http://www.mybatis.org/mybatis-3/zh/getting-started.html　　

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程