MyBatis代理开发(2)

一、开发步骤和程序代码 

1、程序员需要编写user.xml映射文件,程序员编写mapper接口需要遵循一些开发规范，mybatis可以自动生成mapper接口实现类代理对象。

2、创建数据库配置文件db.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=123

3、创建mybatis配置文件SqlMapConfig.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>
    <!-- 加载属性文件 -->
    <properties resource="db.properties"></properties>
    
    <!-- 全局配置参数，需要时再设置 -->
    <!-- <settings></settings> -->
    
    <!-- 别名定义 -->
    <typeAliases>
        <!-- 针对单个别名定义 type：类型的路径 alias：别名 -->
        <!-- <typeAlias type="com.zhang.domain.User" alias="user"/> -->
        <!-- 批量别名定义  指定包名，mybatis自动扫描包中的po类，自动定义别名，别名就是类名（首字母大写或小写都可以）-->
        <package name="com.zhang.domain"/>
    </typeAliases>
    
    <environments default="development">
        <environment id="development">
        <!-- 使用jdbc事务管理，事务控制由mybatis-->
            <transactionManager type="JDBC" />
        <!-- 数据库连接池，由mybatis管理-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}" />
                <property name="url" value="${jdbc.url}" />
                <property name="username" value="${jdbc.username}" />
                <property name="password" value="${jdbc.password}" />
            </dataSource>
        </environment>
    </environments>
    
    <mappers>
        <mapper resource="sqlmap/User.xml"/>
        
        <!-- 通过mapper接口加载单个 映射文件
        遵循一些规范：需要将mapper接口类名和User.xml映射文件名称保持一致，且在一个目录 中
        上边规范的前提是：使用的是mapper代理方法
         -->
        <!-- <mapper class="com.zhang.dao.UserDao"/> -->
        
        <!-- 批量加载mapper
        指定mapper接口的包名，mybatis自动扫描包下边所有mapper接口进行加载
        遵循一些规范：需要将mapper接口类名和User.xml映射文件名称保持一致，且在一个目录 中
        上边规范的前提是：使用的是mapper代理方法
         -->
    <!--     <package name="com.zhang.dao"/> -->
    </mappers>
</configuration>

4、创建接口类UserDao.java

package com.zhang.dao;

import java.util.List;
import com.zhang.domain.User;

public interface UserDao {
    
    //根据id查询用户信息，使用resultMap输出
    public User findUserByIdResultMap(int id) throws Exception;
        
    //根据id查询用户信息
    public User findUserById(int id) throws Exception;
    
    //根据用户名列查询用户列表
    public List<User> findUserByName(String name) throws Exception;
    
    //添加用户信息
    public void insertUser(User user) throws Exception;
    
    //删除用户信息
    public void deleteUser(int id) throws Exception;

}

5、创建user.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>
    <!-- 加载属性文件 -->
    <properties resource="db.properties"></properties>
    
    <!-- 全局配置参数，需要时再设置 -->
    <!-- <settings></settings> -->
    
    <!-- 别名定义 -->
    <typeAliases>
        <!-- 针对单个别名定义 type：类型的路径 alias：别名 -->
        <!-- <typeAlias type="com.zhang.domain.User" alias="user"/> -->
        <!-- 批量别名定义  指定包名，mybatis自动扫描包中的po类，自动定义别名，别名就是类名（首字母大写或小写都可以）-->
        <package name="com.zhang.domain"/>
    </typeAliases>
    
    <environments default="development">
        <environment id="development">
        <!-- 使用jdbc事务管理，事务控制由mybatis-->
            <transactionManager type="JDBC" />
        <!-- 数据库连接池，由mybatis管理-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}" />
                <property name="url" value="${jdbc.url}" />
                <property name="username" value="${jdbc.username}" />
                <property name="password" value="${jdbc.password}" />
            </dataSource>
        </environment>
    </environments>
    
    <mappers>
        <mapper resource="sqlmap/User.xml"/>
        
        <!-- 通过mapper接口加载单个 映射文件
        遵循一些规范：需要将mapper接口类名和User.xml映射文件名称保持一致，且在一个目录 中
        上边规范的前提是：使用的是mapper代理方法
         -->
        <!-- <mapper class="com.zhang.dao.UserDao"/> -->
        
        <!-- 批量加载mapper
        指定mapper接口的包名，mybatis自动扫描包下边所有mapper接口进行加载
        遵循一些规范：需要将mapper接口类名和User.xml映射文件名称保持一致，且在一个目录 中
        上边规范的前提是：使用的是mapper代理方法
         -->
    <!--     <package name="com.zhang.dao"/> -->
    </mappers>
</configuration>

6、创建实体类User.java文件

package com.zhang.domain;

import java.util.Date;
public class User {
    
    //属性名和数据库表的字段对应
    private int id;
    private String username;// 用户姓名
    private String sex;// 性别
    private Date birthday;// 生日
    private String address;// 地址
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
    public Date getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
    public String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
    }
    @Override
    public String toString() {
        return "User [id=" + id + ", username=" + username + ", sex=" + sex
                + ", birthday=" + birthday + ", address=" + address + "]";
    }


}

7、测试，创建测试类TestMy.java

package com.zhang.test;

import java.io.InputStream;
import java.util.Date;
import java.util.List;

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 org.junit.Before;
import org.junit.Test;

import com.zhang.dao.UserDao;
import com.zhang.domain.User;

public class TestMy {
    private SqlSessionFactory sqlSessionFactory;

    // 此方法是在执行testFindUserById之前执行
    @Before
    public void setUp() throws Exception {
        // 创建sqlSessionFactory
        // mybatis配置文件
        String resource = "SqlMapConfig.xml";
        // 得到配置文件流
        InputStream inputStream = Resources.getResourceAsStream(resource);
        // 创建会话工厂，传入mybatis的配置文件信息
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    
    @Test
    public void testFindUserById() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        //调用userMapper的方法
        User user = userDao.findUserById(1);
        System.out.println(user);
    }
    
    @Test
    public void testFindUserByName() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        //调用userMapper的方法
        List<User> list = userDao.findUserByName("小明");
        sqlSession.close();
        System.out.println(list);
    }

    @Test
    public void insertUser() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        User user=new User();
        user.setAddress("深圳");
        user.setBirthday(new Date());
        user.setSex("女");
        user.setUsername("zhangjinru");
        //调用userMapper的方法
        userDao.insertUser(user);
        //提交事务
        sqlSession.commit();
        sqlSession.close();
    }
    
    @Test
    public void deleteUser() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        //调用userMapper的方法
        userDao.deleteUser(24);
        // 提交事务
        sqlSession.commit();
        sqlSession.close();
    }

    @Test
    public void testFindUserByIdResultMap() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserDao对象，mybatis自动生成mapper代理对象
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        //调用userDao的方法
        User user = userDao.findUserByIdResultMap(1);
        System.out.println(user);
    }
    

}

 8、整个工程目录结构

二、一些问题总结

1、在user.xml中namespace等于UserDao接口地址

2、UserDao.java接口中的方法名和user.xml中statement的id一致

3、UserDao.java接口中的方法输入参数类型和user.xml中statement的parameterType指定的类型一致。UserDao.java接口中的方法返回值类型和user.xml中statement的resultType指定的类型一致

4、代理对象内部调用selectOne或selectList ，如果mapper方法返回单个pojo对象（非集合对象），代理对象内部通过selectOne查询数据库。如果mapper方法返回集合对象，代理对象内部通过selectList查询数据库。

5、typeAliases（别名）

在user.xml中，定义很多的statement，statement需要parameterType指定输入参数的类型、需要resultType指定输出结果的映射类型。

如果在指定类型时输入类型全路径，不方便进行开发，可以针parameterType或resultType指定的类型定义一些别名，在user.xml中通过别名定义，方便开发。

 6、通过resource加载单个映射文件

7、通过mapper接口加载单个mapper，按照上边的规范，将User.java和User.xml放在一个目录 ，且同名。

 资源下载地址：http://download.csdn.net/detail/u013865056/9907003