Mybatis(二)Mapper的开发规范

川长思鸟来 2022-06-01 09:09 206阅读 0赞

## 1. **SqlSession的使用范围** ##

SqlSession中封装了对数据库的操作，如：查询、插入、更新、删除等。

通过SqlSessionFactory创建SqlSession，而SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。

### 1.1 **SqlSessionFactoryBuilder** ###

SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，因为SqlSession是通过SqlSessionFactory生产，所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是方法范围即方法体内局部变量。

### 1.2 **SqlSessionFactory** ###

SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。

### 1.3 **SqlSession** ###

SqlSession是一个面向用户的接口，sqlSession中定义了数据库操作方法。

每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。

打开一个 SqlSession；使用完毕就要关闭它。通常把这个关闭操作放到finally块中以确保每次都能执行关闭。如下：

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

## 2. **Mapper动态代理方式** ##

### 2.1 **开发规范** ###

Mapper接口开发方法只需要程序员编写Mapper接口（相当于Dao接口），由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。

Mapper接口开发需要遵循以下规范：

1、 Mapper.xml文件中的namespace与mapper接口的类路径相同。

2、  Mapper接口方法名和Mapper.xml中定义的每个statement的id相同

3、 Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql的parameterType的类型相同

4、 Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

### 2.2 **Mapper.xml(映射文件)** ###

定义mapper映射文件UserMapper.xml（内容同Users.xml），需要修改namespace的值为UserMapper接口路径。将UserMapper.xml放在classpath下mapper目录 下。

<?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="cn.itcast.mybatis.mapper.UserMapper">
    
    	<select id="findUserById" parameterType="int" resultType="cn.itcast.mybatis.po.User">
    		select * from user where id = #{id}
    	</select>
    
    	<select id="findUserByUsername" parameterType="java.lang.String" 
    			resultType="cn.itcast.mybatis.po.User">
    	   select * from user where username like '%${value}%' 
    	</select>
    
    	<insert id="insertUser" parameterType="cn.itcast.mybatis.po.User">
    	<selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
    		select LAST_INSERT_ID() 
    	</selectKey>
    	  insert into user(username,birthday,sex,address) 
    	  values(#{username},#{birthday},#{sex},#{address})
    	</insert>
    
    </mapper>

### 2.3 **Mapper.java(接口文件)** ###

/**
     * 用户管理mapper
     */
    Public interface UserMapper {
    	//根据用户id查询用户信息
    	public User findUserById(int id) throws Exception;
    	//查询用户列表
    	public List<User> findUserByUsername(String username) throws Exception;
    	//添加用户信息
    	public void insertUser(User user)throws Exception; 
    }

接口定义有如下特点：

1、 Mapper接口方法名和Mapper.xml中定义的statement的id相同

2、 Mapper接口方法的输入参数类型和mapper.xml中定义的statement的parameterType的类型相同

3、 Mapper接口方法的输出参数类型和mapper.xml中定义的statement的resultType的类型相同

### 2.4 **加载UserMapper.xml文件** ###

修改SqlMapConfig.xml文件：

<mappers>
        <mapper resource="mapper/UserMapper.xml"/>
      </mappers>

### 2.5 **测试** ###

Public class UserMapperTest extends TestCase {
    
    	private SqlSessionFactory sqlSessionFactory;
    	
    	protected void setUp() throws Exception {
    		//mybatis配置文件
    		String resource = "sqlMapConfig.xml";
    		InputStream inputStream = Resources.getResourceAsStream(resource);
    		//使用SqlSessionFactoryBuilder创建sessionFactory
    		sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    	}
    
    	
    	Public void testFindUserById() throws Exception {
    		//获取session
    		SqlSession session = sqlSessionFactory.openSession();
    		//获取mapper接口的代理对象
    		UserMapper userMapper = session.getMapper(UserMapper.class);
    		//调用代理对象方法
    		User user = userMapper.findUserById(1);
    		System.out.println(user);
    		//关闭session
    		session.close();
    		
    	}
    	@Test
    	public void testFindUserByUsername() throws Exception {
    		SqlSession sqlSession = sqlSessionFactory.openSession();
    		UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    		List<User> list = userMapper.findUserByUsername("张");
    		System.out.println(list.size());
    
    	}
    Public void testInsertUser() throws Exception {
    		//获取session
    		SqlSession session = sqlSessionFactory.openSession();
    		//获取mapper接口的代理对象
    		UserMapper userMapper = session.getMapper(UserMapper.class);
    		//要添加的数据
    		User user = new User();
    		user.setUsername("张三");
    		user.setBirthday(new Date());
    		user.setSex("1");
    		user.setAddress("北京市");
    		//通过mapper接口添加用户
    		userMapper.insertUser(user);
    		//提交
    		session.commit();
    		//关闭session
    		session.close();
    	}
    	
    
    }

### 2.6 **小结** ###

selectOne和selectList

动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定，如果返回list则调用selectList方法，如果返回单个对象则调用selectOne方法。

namespace

mybatis官方推荐使用mapper代理方法开发mapper接口，程序员不用编写mapper接口实现类，使用mapper代理方法时，输入参数可以使用pojo包装对象或map对象，保证dao的通用性。

当然，你也可以使用注解的方式来实现,比如以下方式:

@Select("select * from mybatis_Student where id=#{id}")  
    public Student getStudent(int id);  
    @Insert("insert into mybatis_Student (name, age, remark, pic,grade_id,address_id) values (#{name},#{age},#{remark}, #{pic},#{grade.id},#{address.id})")  
    public int insert(Student student);  
    @Update("update mybatis_Student set name=#{name},age=#{age} where id=#{id}")  
    public int update(Student student);  
    @Delete("delete from mybatis_Student where id=#{id}")  
    public int delete(int id);

个人的使用方式建议:注解与mapper相结合，逻辑较为简单的SQL语句使用注解，逻辑较为复杂的使用mapper!