首页 > 代码库 > MyBatis《1》

MyBatis《1》

2024-09-05 19:41:00   216人阅读

 MyBatis入参考文档：http://mybatis.org/mybatis-3/zh/ 

1.使用MyBatis前的准备

1.增加Maven依赖
  1. <dependency>
  2. <groupId>mysql</groupId>
  3. <artifactId>mysql-connector-java</artifactId>
  4. <version>5.1.37</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>org.mybatis</groupId>
  8. <artifactId>mybatis</artifactId>
  9. <version>3.3.0</version>
  10. </dependency>
2.数据库建表
  1. CREATE TABLE tb_teacher
  2. (
  3. id bigint NOT NULL auto_increment COMMENT ‘ID‘,
  4. no varchar(10) NOT NULL COMMENT ‘教师编号‘,
  5. name varchar(50) NOT NULL COMMENT ‘教师姓名‘,
  6. sex char(1) NOT NULL COMMENT ‘教师性别‘,
  7. job_title varchar(50) NOT NULL COMMENT ‘职称‘,
  8. PRIMARY KEY (id)
  9. ) COMMENT = ‘教师信息表‘;
  10. INSERT INTO tb_teacher (no, name, sex, job_title) VALUES (‘001‘, ‘Test01‘, ‘f‘, ‘教师01‘);
  11. INSERT INTO tb_teacher (no, name, sex, job_title) VALUES (‘002‘, ‘Test02‘, ‘f‘, ‘教师02‘);
  12. INSERT INTO tb_teacher (no, name, sex, job_title) VALUES (‘003‘, ‘Test03‘, ‘f‘, ‘教师03‘);
3.创建实体类
  1. package model;
  2. import java.io.Serializable;
  3. /** 教师信息表 */
  4. public class Teacher implements Serializable
  5. {
  6. private static final long serialVersionUID = 1L;
  7. /** ID */
  8. private Long id;
  9. /** 教师编号 */
  10. private String no;
  11. /** 教师姓名 */
  12. private String name;
  13. /** 教师性别 */
  14. private String sex;
  15. /** 职称 */
  16. private String job_title;
  17. ......
  18. }

2.创建SqlSessionFactory

1.使用XML配置文件创建SqlSessionFactory
    
    从XML文件中构建SqlSessionFactory的实例非常简单，建议使用类路径下的资源文件进行配置。但是也可以使用任意的输入流(InputStream)实例，包括字符串形式的文件路径或者 file:// 的 URL 形式的文件路径来配置。MyBatis包含一个名叫Resources的工具类，它包含一些实用方法，可使从classpath或其他位置加载资源文件更加容易。
  1. String resource = "mybatis-config.xml";
  2. InputStream inputStream = Resources.getResourceAsStream(resource);
  3. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
创建配置文件mybatis-config.xml
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
  3. <configuration>
  4. <environments default="development">
  5. <environment id="development">
  6. <transactionManager type="JDBC" />
  7. <dataSource type="POOLED">
  8. <property name="driver" value="com.mysql.jdbc.Driver" />
  9. <property name="url" value="jdbc:mysql://localhost:3306/test" />
  10. <property name="username" value="root" />
  11. <property name="password" value="lizhiwei" />
  12. </dataSource>
  13. </environment>
  14. </environments>
  15. <mappers>
  16. <mapper resource="mapping/TeacherMapper.xml" />
  17. </mappers>
  18. </configuration>
实体类映射文件：mapping/TeacherMapper.xml：
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="mapping.TeacherDao">
  4. <select id="getTeacherById" resultType="model.Teacher" parameterType="_int">
  5. select * from tb_teacher WHERE id = #{id};
  6. </select>
  7. </mapper>
2.直接使用API创建SqlSessionFactory
    如果你更愿意直接从Java程序而不是XML文件中创建configuration，或者创建你自己的configuration构建器，MyBatis也提供了完整的配置类，提供所有和XML文件相同功能的配置项。
  1. DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
  2. TransactionFactory transactionFactory = new JdbcTransactionFactory();
  3. Environment environment = new Environment("development", transactionFactory, dataSource);
  4. Configuration configuration = new Configuration(environment);
  5. configuration.addMapper(BlogMapper.class);
  6. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

3.创建SqlSession操作数据库

1.直接使用映射文件TeacherMapper.xml中的SQL
  1. Teacher teacher = sqlSession.selectOne("mapping.TeacherDao.getTeacherById",1);
  2. System.out.println(teacher);
  3. sqlSession.close();
参数“mapping.TeacherDao.getTeacherById”就指定是TeacherMapper.xml文件中select语句(通过“namespace” + “id”)
2.使用接口关联映射文件TeacherMapper.xml
创建接口：TeacherDao
  1. package mapping;
  2. import model.Teacher;
  3. public interface TeacherDao
  4. {
  5. public Teacher getTeacherById(int id);
  6. }
使用MyBatis的Mapper功能，获取接口实例，并使用：
  1. TeacherDao teacherDao = sqlSession.getMapper(TeacherDao.class);
  2. teacher = teacherDao.getTeacherById(2);
  3. System.out.println(teacher);
  4. sqlSession.close();
使用Mapper接口的方式，不用写接口实现类接口完成数据库操作，简单方便，此方法是官方推荐。是MyBatis一种很重要的用法。
注意：使用 Mapper 接口调用必须具备以下条件：
  1. Mapper 接口方法名 和 TeacherMapper.xml中定义的每个 sql 的 id 同名。
  2. Mapper 接口方法的输入参数类型和 TeacherMapper.xml中定义的 sql parameterType类型相同。
  3. Mapper 接口的输出参数类型和 TeacherMapper.xml中 定义的 sql 的 resultType类型相同。
  4. TeacherMapper.xml文件中的 namespace即是 Mapper 接口的类路径。
 

4.各种主要接口实例的生命周期

1.SqlSessionFactoryBuilder
    这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。因此SqlSessionFactoryBuilder实例的最佳范围是方法范围（也就是局部方法变量）。你可以重用SqlSessionFactoryBuilder来创建多个 SqlSessionFactory 实例，但是最好还是不要让其一直存在以保证所有的 XML 解析资源开放给更重要的事情。
2.SqlSessionFactory
    SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由对它进行清除或重建。使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏味道（bad smell）”。因此 SqlSessionFactory 的最佳范围是应用范围。有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。
3.SqlSession
    每个线程都应该有它自己的SqlSession实例。SqlSession的实例不是线程安全的，因此是不能被共享的，所以它的最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。也绝不能将SqlSession实例的引用放在任何类型的管理范围中，比如Serlvet架构中的HttpSession。如果你现在正在使用一种Web框架，要考虑SqlSession放在一个和HTTP请求对象相似的范围中。换句话说，每次收到的HTTP请求，就可以打开一个SqlSession，返回一个响应，就关闭它。这个关闭操作是很重要的，你应该把这个关闭操作放到finally块中以确保每次都能执行关闭。
4.映射器实例（Mapper Instances）
    映射器是创建用来绑定映射语句的接口。映射器接口的实例是从SqlSession中获得的。因此从技术层面讲，映射器实例的最大范围是和SqlSession相同的，因为它们都是从SqlSession里被请求的。尽管如此，映射器实例的最佳范围是方法范围。也就是说，映射器实例应该在调用它们的方法中被请求，用过之后即可废弃。并不需要显式地关闭映射器实例，尽管在整个请求范围（request scope）保持映射器实例也不会有什么问题，但是很快你会发现，像SqlSession一样，在这个范围上管理太多的资源的话会难于控制。所以要保持简单，最好把映射器放在方法范围（method scope）内。
------------------------------------------------------------------------------------------------------------------------------- 
 

MyBatis《1》


联系
我们