JavaEE Spring+Mybatis整合

  1. 云栖社区>
  2. 博客>
  3. 正文

JavaEE Spring+Mybatis整合

凌浩雨 2018-04-16 12:56:00 浏览442
展开阅读全文

1. MyBatis整合Spring所需的jar包如下:

2.整合思路

MyBatis整合Spring的思路如下:

  • SqlSessionFactory对象应该放到spring容器中作为单例存在。
  • 传统Dao的开发方式中,应该从spring容器中获得sqlsession对象。
  • Mapper代理形式中,应该从spring容器中直接获得mapper的代理对象。
  • 数据库的连接以及数据库连接池事务管理都交给spring容器来完成。

3. 整合的步骤

下面我将按照下面整合的步骤来整合MyBatis与Spring:

第一步:创建一个java工程。
第二步:导入jar包(上面提到的jar包)。
第三步:编写mybatis的配置文件——SqlMapConfig.xml。
第四步:编写Spring的配置文件。 
        1. 数据库连接及连接池
        2.事务管理(暂时可以不配置)
        3. sqlsessionFactory对象,配置到spring容器中
        4. mapper代理对象或者是dao实现类配置到spring容器中
第五步:编写Dao或者mapper.xml映射文件。
第六步:测试。

3. 创建工程,导入jar包

img_e92999048c0d3e80b00dc68db7065dcd.png
图2.png

4. 创建配置文件

1). 在工程下创建源码包config
img_ff4d757f278dfeee9b6bcd67458c2f32.png
图3.png
2). 在config下db.properties文件
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root
img_233be361715938555a3a806d53ebd5b8.png
图4.png
3). 在config下创建spring包,并在spring包下创建application-context.xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
                        http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
                        http://www.springframework.org/schema/context 
                        http://www.springframework.org/schema/context/spring-context-4.0.xsd
                        http://www.springframework.org/schema/aop 
                        http://www.springframework.org/schema/aop/spring-aop-4.0.xsd 
                        http://www.springframework.org/schema/tx 
                        http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
                        http://www.springframework.org/schema/util 
                        http://www.springframework.org/schema/util/spring-util-4.0.xsd">
    
    <!-- 加载配置文件 -->
    <context:property-placeholder location="classpath:db.properties"/> 
    <!-- 数据库连接池 -->                   
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
        <!-- 设置最大连接数 -->
        <property name="maxTotal" value="10"/>
        <!-- 设置最大空闲数 -->
        <property name="maxIdle" value="5"/>
    </bean>
    
    <!-- SqlSessionFactory的配置 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 配置数据库连接池 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 加载Mybatis的核心配置文件 -->
        <property name="configLocation" value="classpath:mybatis/SqlMapConfig.xml"></property>
    </bean>
    
</beans>
4). 在config下创建mybatis包,并在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>
    <!-- 配置pojo别名 -->
    <typeAliases>
        <!-- 扫描包的形式创建别名,别名就是类型,不区分大小写 -->
        <!-- <package name="xxx.xxx.xxx"/> -->
    </typeAliases>

    <!-- 加载mapper文件 -->
    <mappers>
        <!-- 加载Mapper.xml文件,采用包加载 -->
        <!-- <package name="com.mazaiting.mapper" /> -->
    </mappers>
</configuration>

5. Dao层的开发

  • 传统Dao层的开发方式
  • 使用mapper代理形式开发方式
  • 使用扫描包配置mapper代理
1). 传统Dao层的开发方式

I. 在com.mazaiting.po包下创建User.java

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 + "]";
    }
    
}

II. 修改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>
    <!-- 配置pojo别名 -->
    <typeAliases>
        <!-- 扫描包的形式创建别名,别名就是类型,不区分大小写 -->
        <!-- <package name="xxx.xxx.xxx"/> -->
        <package name="com.mazaiting.po"/>
    </typeAliases>

    <!-- 加载mapper文件 -->
    <mappers>
        <!-- resource是基于classpath来加载的 -->
        <mapper resource="sqlmap/user.xml"/>
        <!-- 加载Mapper.xml文件,采用包加载 -->
        <!-- <package name="com.mazaiting.mapper" /> -->    
    </mappers>
</configuration>

III. 在config包下创建sqlmap包,并在sqlmap包下创建user.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="test">
    <select id="getUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>
    
    <select id="getUserByName" parameterType="string" resultType="user">
        select * from user where username like '%${value}%'
    </select>
    
    <select id="addUser" parameterType="user">
        insert into user(username, birthday,sex,address)
        values(#{username},#{birthday},#{sex},#{address})
    </select>
</mapper>

IV. 在com.mazaiting.dao包下创建User接口

public interface UserDao {
    User getUserById(int id);
    List<User> getUserByName(String username);
    void addUser(User user);
}

V. 在com.mazaiting.dao.impl下创建实现UserDao接口和继承SqlsessionDaoSupport的类UserDaoImpl

public class UserDaoImpl extends SqlSessionDaoSupport implements UserDao {

    @Override
    public User getUserById(int id) {
        SqlSession session = getSqlSession();
        User user = session.selectOne("getUserById", 10);
        return user;
    }

    @Override
    public List<User> getUserByName(String username) {
        SqlSession session = getSqlSession();
        List<User> list = session.selectList("getUserByName", "张");
        return list;
    }

    @Override
    public void addUser(User user) {
        SqlSession session = getSqlSession();
        session.insert("addUser", user);
         // 提交事务
        session.commit();
    }
}

注意:以上每个方法中不要手动关闭SqlSession,如果你手动关闭了,就会抛出一个异常。
VI. 在application-context.xml文件中配置UserDaoImpl

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
                        http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
                        http://www.springframework.org/schema/context 
                        http://www.springframework.org/schema/context/spring-context-4.0.xsd
                        http://www.springframework.org/schema/aop 
                        http://www.springframework.org/schema/aop/spring-aop-4.0.xsd 
                        http://www.springframework.org/schema/tx 
                        http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
                        http://www.springframework.org/schema/util 
                        http://www.springframework.org/schema/util/spring-util-4.0.xsd">
    
    <!-- 加载配置文件 -->
    <context:property-placeholder location="classpath:db.properties"/> 
    <!-- 数据库连接池 -->                   
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
        <!-- 设置最大连接数 -->
        <property name="maxTotal" value="10"/>
        <!-- 设置最大空闲数 -->
        <property name="maxIdle" value="5"/>
    </bean>
    
    <!-- SqlSessionFactory的配置 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 配置数据库连接池 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 加载Mybatis的核心配置文件 -->
        <property name="configLocation" value="classpath:mybatis/SqlMapConfig.xml"></property>
    </bean>
    
    <bean id="userDaoImpl" class="com.mazaiting.dao.impl.UserDaoImpl">
        <property name="sqlSessionFactory" ref="sqlSessionFactory"></property>
    </bean>
</beans>

VII. 在工程路径下创建test源码包,并创建对应包下的测试类

public class UserDaoTest {
    private ApplicationContext context;
    
    @Before
    public void init(){
        // 初始化Spring容器
        context = new ClassPathXmlApplicationContext("classpath:spring/application-context.xml");
    }
    
    @Test
    public void testGetUserById(){
        // 通过类型装配
        UserDao dao = context.getBean(UserDao.class);
        User user = dao.getUserById(24);
        System.out.println(user);
    }
}

VIII. 打印结果:


img_8b6b36c50d61bc5ad271a35a3d205efc.png
图5.png

VIIII. 如果getUserById的方法中手动关闭session, 则会抛出java.lang.UnsupportedOperationException: Manual close is not allowed over a Spring managed SqlSession异常。因此在方法中一定不能调用session.close()方法。

img_8909180de19a7e980a41d5d037a04a14.png
图6.png

2). 使用mapper代理形式开发方式

I. 创建一个UserMapper接口

public interface UserMapper {
    User getUserById(int id);
    List<User> getUserByName(String username);
    void addUser(User user);
}

II. 创建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.mazaiting.mapper.UserMapper">
    <select id="getUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>
    
    <select id="getUserByName" parameterType="string" resultType="user">
        select * from user where username like '%${value}%'
    </select>
    
    <select id="addUser" parameterType="user">
        insert into user(username, birthday,sex,address)
        values(#{username},#{birthday},#{sex},#{address})
    </select>
</mapper>

III. 在application-context.xml文件中配置Mapper代理

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
                        http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
                        http://www.springframework.org/schema/context 
                        http://www.springframework.org/schema/context/spring-context-4.0.xsd
                        http://www.springframework.org/schema/aop 
                        http://www.springframework.org/schema/aop/spring-aop-4.0.xsd 
                        http://www.springframework.org/schema/tx 
                        http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
                        http://www.springframework.org/schema/util 
                        http://www.springframework.org/schema/util/spring-util-4.0.xsd">
    
    <!-- 加载配置文件 -->
    <context:property-placeholder location="classpath:db.properties"/> 
    <!-- 数据库连接池 -->                   
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
        <!-- 设置最大连接数 -->
        <property name="maxTotal" value="10"/>
        <!-- 设置最大空闲数 -->
        <property name="maxIdle" value="5"/>
    </bean>
    
    <!-- SqlSessionFactory的配置 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 配置数据库连接池 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 加载Mybatis的核心配置文件 -->
        <property name="configLocation" value="classpath:mybatis/SqlMapConfig.xml"></property>
    </bean>

    <!-- 配置代理对象 -->
    <bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
        <!-- 设置代理的mapper接口,即为哪一个类创建代理对象 -->
        <property name="mapperInterface" value="com.mazaiting.mapper.UserMapper"></property>
        <!-- 由于MapperFactoryBean类继承自SqlSessionDaoSupport类,所以注入SqlSessionFactory类 -->
        <property name="sqlSessionFactory" ref="sqlSessionFactory"></property>
    </bean>
</beans>

IV. 测试类

public class UserMapperTest {

    ApplicationContext context;
    
    @Before
    public void init() {
        context = new ClassPathXmlApplicationContext("classpath:spring/application-context.xml");
    }
    
    @Test
    public void testGetUserById() {
        UserMapper mapper = context.getBean(UserMapper.class);
        User user = mapper.getUserById(24);
        System.out.println(user.toString());
    }
    
}

V. 打印结果:


img_64b94c3549c6abab1546c7985369084e.png
图7.png
3). 使用扫描包配置mapper代理

I. 在application-context.xml文件中配置一个包扫描器

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p"
    xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
                        http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
                        http://www.springframework.org/schema/context 
                        http://www.springframework.org/schema/context/spring-context-4.0.xsd
                        http://www.springframework.org/schema/aop 
                        http://www.springframework.org/schema/aop/spring-aop-4.0.xsd 
                        http://www.springframework.org/schema/tx 
                        http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
                        http://www.springframework.org/schema/util 
                        http://www.springframework.org/schema/util/spring-util-4.0.xsd">
    
    <!-- 加载配置文件 -->
    <context:property-placeholder location="classpath:db.properties"/> 
    <!-- 数据库连接池 -->                   
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
        <!-- 设置最大连接数 -->
        <property name="maxTotal" value="10"/>
        <!-- 设置最大空闲数 -->
        <property name="maxIdle" value="5"/>
    </bean>
    
    <!-- SqlSessionFactory的配置 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 配置数据库连接池 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 加载Mybatis的核心配置文件 -->
        <property name="configLocation" value="classpath:mybatis/SqlMapConfig.xml"></property>
    </bean>
    
    <!-- 配置包扫描器 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 配置要扫描的包 -->
        <property name="basePackage" value="com.mazaiting.mapper"/>
    </bean>
</beans>

注意:

  • 该扫描器会自动去Spring容器中去找你已经初始化好后的sqlSessionFactory, 所以在此并不需要配置。
  • 如果要扫描多个包,那么使用半角逗号分隔。
  • 使用扫描包的形式配置mapper代理之后,每个mapper代理对象的id就是类名,且首字母小写。

特别注意:
如果在application-context.xml文件中配置了扫描包之后,在SqlMapConfig.xml配置文件中就不需要以下配置了:

<!-- 加载mapper文件 -->
<mappers>
    <!-- resource是基于classpath来加载的 -->
    <mapper resource="sqlmap/user.xml" />
</mappers>

II. 测试testGetUserById方法结果:


img_e8b1fe9002494fcaeecce81b37cce79f.png
图8.png

6. 逆向工程

MyBatis的一个主要的特点就是需要程序员自己编写sql,那么如果表太多的话,难免会很麻烦,所以mybatis官方提供了一个逆向工程,可以针对单表自动生成mybatis执行所需要的代码(包括mapper.xml、mapper.java、po..)。一般在开发中,常用的逆向工程方式是通过数据库的表生成代码。

1). 工具包

使用MyBatis的逆向工程,需要导入逆向工程的jar包mybatis-generator-core-1.3.6.jar

img_add44321d8872138cc564b5fc0f86938.png
图9.png

2). 新建工程(切勿在原项目中使用)

I. 配置generatorConfig.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <context id="testTables" targetRuntime="MyBatis3">
        <commentGenerator>
            <!-- 是否去除自动生成的注释 true是,false否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!-- 数据库连接信息:驱动类、连接地址、用户名、密码 -->
        <jdbcConnection 
            driverClass="com.mysql.jdbc.Driver" 
            connectionURL="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8"
            userId="root" password="root"/>
        <!-- 默认false,把JDBC DECIMAL 和 NUMBERIC类型解析为Integer;
            为true时把JDBC DECIMAL和NUMBERIC类型解析为java.math.BigDecimal   
        -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- targetProject:生成PO类型的位置 -->
        <javaModelGenerator 
            targetPackage="com.mazaiting.po"
            targetProject=".\src">
            <!-- enableSubPackages是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator 
            targetPackage="com.mazaiting.mapper"
            targetProject=".\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!-- targetPackage: mapper接口生成的位置 -->
        <javaClientGenerator 
            targetPackage="com.mazaiting.mapper"
            type="XMLMAPPER"
            targetProject=".\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>  
        </javaClientGenerator>
        <!-- 指定数据库表 -->
        <table tableName="user"/>
        <table tableName="orders"/>
        
        <!-- 有些表的字段需要指定java类型
         <table schema="" tableName="">
            <columnOverride column="" javaType="" />
        </table> -->
    </context>
</generatorConfiguration>

II. 在src目录下创建log4j.properties文件

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

III. 创建生成代码

public class GeneratorSqlmap {
    public static void main(String[] args) throws Exception {
        List<String> warnings = new ArrayList<>();
        boolean overwrite = true;
        // 指定逆向工程配置文件
        File configFile = new File("generatorConfig.xml");
        ConfigurationParser cParser = new ConfigurationParser(warnings);
        Configuration config = cParser.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator generator = new MyBatisGenerator(config, callback, warnings);
        generator.generate(null);
    }
}

IV. 运行后刷新项目


img_8065d16d4799ae901799e0f76ba1800c.png
图10.png

代码下载

网友评论

登录后评论
0/500
评论
凌浩雨
+ 关注