SSM框架开发应用（三）——MyBatis环境搭建

Undergoer_TW

已于 2022-02-23 23:13:29 修改

阅读量455

点赞数

分类专栏：开发语言 # Java开发文章标签： jar myeclipse java

于 2020-05-06 12:58:01 首次发布

本文是学习笔记、知识分享性质，较多内容引用了相关书籍中的知识、图片等内容，目的只是记录学习笔记，无任何商业用途。如果您对本站所载文章及作品版权的归属存有异议，请及时告知。

本文链接：https://blog.csdn.net/static_eye/article/details/105948587

版权

开发语言同时被 2 个专栏收录

44 篇文章 0 订阅

订阅专栏

Java开发

32 篇文章 0 订阅

订阅专栏

MyBatis环境搭建

在MyEclipse中新建工程后，要使用MyBatis，需要做一下准备工作，如下图所示：
MyBatis环境准备步骤

一、下载所需的jar文件

MyBatis的官方网站是http://mybatis.org
，可以下载到最新Release版本的MyBatis。其他Release版本的MyBatis的jar文件都可以从官方网站下载得到。

【注意】
目前MyBatis官网在国内访问受限，若能访问到官网，则官网的所有下载链接全部引导到github上（https://github.com/mybatis/mybatis-3/releases
）。推荐下载mybatis-3.2.2.zip和mybatis-3-mybatis-3.2.2.zip（通过响应版本的“Source Code(zip) ”链接下载）。

mybatis-3.2.2.zip（MyBatis的jar文件）
Mybatis-3.2.2.zip解压后的目录结构如下图所示：

注意查看根目录（mybatis-3.2.2）和lib目录：
1. 在根目录下存放着mybatis-3.2.2.jar，为MyBatis的jar文件；
2. mybatis-3.2.2.pdf为MyBatis官方使用手册。

lib目录下存放着编译依赖包，如下图所示：
MyBatis编译依赖包
这些jar文件的作用如图4所示：
MyBatis依赖包的文件说明

mybatis-3-mybatis-3.2.2.zip（MyBatis源码包）
Mybatis-3-mybatis-3.2.2.zip是MyBatis的源码包，里面是MyBatis的所有源代码。

解压后目录结构如下图所示：

二、部署jar文件

具体的操作步骤如下。

将下载后的mybatis-3.2.2.jar、mysql-connector-java-5.1.27.jar（MySQL数据库驱动jar文件）及log4j-1.2.17.jar（负责日志输出的jar文件）复制到建好的工程WEB-INF下的lib目录中。
通过MyEclipse导入上述的包。在MyEclipse中的工程上右击，选择“Build Path”-“Configure Build Path”选项。

如图所示：

在弹出的窗体中单击“Add JARs”按钮，如图7所示：

在弹出的“JAR Selection”窗体中选择lib下刚刚复制的jar文件，如图8所示：
选择刚刚复制的jar文件

单击“OK”按钮，这时在工程中加入了所选的jar文件，如图9所示：
导入支持的jar文件

为了更方便地学习MyBatis，可以在MyEclipse环境中设置当前工程中mybatis-3.2.2.jar的源码。

选中mybatis-3.2.2.jar，右击，弹出的快捷菜单如图所示：
右击mybatis-3.2.2.jar弹出的快捷菜单

选择“properties”选项，进入属性界面，选中“Java Source Attachment”选项。

如图所示：
查看mybatis-3.2.2.jar的属性

单击“External Folder”按钮，找到源码所在的目录，即mybatis-3-mybatis-3.2.2。

如图所示：
定位MyBatis源码所在目录

选中目录，单击“确定”按钮即可。

需要注意的是，若源码为jar文件，则单击“External File”按钮，找到源码所在的目录，选中jar文件即可。此处不再赘述。

三、创建MyBatis核心配置文件configuration.xml

MyBatis核心配置文件主要用于配置数据库链接和MyBatis运行时所需的各种特性。包含了设置和影响MyBatis行为的属性。

为了方便管理以后各框架集成所需的配置文件，故需在项目工程下新建Source Folder类型的resources目录。并在此目录下添加MyBatis的核心配置文件，默认文件名为“configuration.xml”。

但需要注意的是，为了方便在框架集成时更好地区分各个配置文件，我们一般将此文件名命名为“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>

	<!-- 引入database.properties文件 -->
	<properties resource="database.properties" />
            
	<!-- 配置mybatis的log实现为LOG4J -->
	<settings>
		<setting name="logImpl" value="LOG4J"/>
	</settings>
            
	<!-- 配置mybatis多套运行环境 -->
	<environments default="development">
		<environment id="development">
			<!-- 配置事务管理器，采用JDBC的事务管理 -->
			<transactionManager type="JDBC" />
			<!-- POOLED：mybatis自带的数据源，JNDI：tomcat的数据源 -->
			<dataSource type="POOLED">
				<property name="driver" value="${driver}" />
				<property name="url" value="${url}" />
				<property name="username" value="${username}" />
				<property name="password" value="${password}" />
			</dataSource>
		</environment>
 	</environments>

	<!-- 将mapper文件加入到配置文件中 -->
	<mappers>
		<mapper resource="com/smbms/dao/user/UserMapper.xml" />
	</mappers>
            
</configuration>

【注意】
MyBatis的示例和上机练习均使用订单系统，该系统使用的数据库是MySQL。
该库下的表包括用户表、角色表、供应商表、订单表、地址信息表。

没有特别说明，MyBatis的示例和练习都在测试类中运行，运行结果在控制台输出。

mybatis-config.xml文件的几个常用元素的作用如下：
(1) configuration：配置文件的根元素节点；
(2) properties：通过resource属性从外部指定properties属性文件（database.properties）。
该属性文件描述数据库链接的相关配置（数据库驱动、链接数据库的url、数据库用户名、数据库密码），位置也是在/resources目录下；

        driver=com.mysql.jdbc.Driver
        url=jdbc:mysql://127.0.0.1:3306/MyBatis
        username=root
        password=root

(3) settings：设置MyBatis运行中的一些行为，比如此处设置MyBatis的log日志实现为LOG4J，即使用log4j实现日志功能；
(4) environments：表示配置MyBatis的多套运行环境，将SQL映射到多个不同的数据库上。
该元素节点下可以配置多个environment子元素节点，但是必须指定其中一个默认运行环境（通过default属性指定）；
(5) environment：配置MyBatis的一套运行环境，需指定运行环境ID、事务管理、数据源配置等相关信息；
(6) mappers：作用是告诉MyBatis去哪里找到SQL映射文件（该文件内容是开发者定义的映射SQL语句），整个项目中可以有1个或多个SQL映射文件；
(7) mapper：mappers的子元素节点，具体指定SQL映射文件的路径，其中resource属性的值表述了SQL映射文件的路径（类资源路径）。

【注意】
必须注意的是，mybatis-config.xml文件的元素节点是有一定顺序的。
节点位置若不按照顺序排位，那么XML文件会报错。

完成了MyBatis的配置文件mybatis-config.xml，接下来就要准备持久化类和SQL映射文件了。

四、创建持久化类（POJO）和SQL映射文件

持久化类是指其实实例状态需要被MyBatis持久化到数据库中的类。在应用的设计中，持久化类通常对应需求中的业务实体。

MyBatis一般采用POJO编程模型来实现持久化类，与POJO类配合完成持久化工作是MyBatis最常见的工作模式。

POJO（Plain Ordinary Java Object），从字面上来讲就是普通Java对象。POJO类可以简单地理解为符合JavaBean规范的实体类，它不需要继承和实现任何特殊的Java基类或者接口。JavaBean对象的状态保存在属性中，访问属性必须通过对应的getter和setter方法。

下面首先以用户表（smbms_user）为例，定义用户POJO类。

User.java的代码如下所示：

        package com.smbms.pojo;

        import java.util.Date;

        /**
         * @文件描述 POJO，用户信息 
         * @创建用户 undergoer
         * @创建时间 2017年5月18日 上午3:38:13
         */
        public class User {
            // 字段
            private Integer id;         //id 
            private String userCode;    //用户编码
            private String userName;    //用户名称
            private String userPassword; //用户密码
            private Integer gender;     //性别
            private Date birthday;      //出生日期
            private String phone;       //电话
            private String address;     //地址
            private Integer userRole;   //用户角色
            private Integer createdBy;  //创建者
            private Date creationDate;  //创建时间
            private Integer modifyBy;   //更新者
            private Date modifyDate;    //更新时间
            
            // getters & setters
            public Integer getId() {
                return id;
            }
            public void setId(Integer id) {
                this.id = id;
            }
            public String getUserCode() {
                return userCode;
            }
            public void setUserCode(String userCode) {
                this.userCode = userCode;
            }
            public String getUserName() {
                return userName;
            }
            public void setUserName(String userName) {
                this.userName = userName;
            }
            public String getUserPassword() {
                return userPassword;
            }
            public void setUserPassword(String userPassword) {
                this.userPassword = userPassword;
            }
            public Integer getGender() {
                return gender;
            }
            public void setGender(Integer gender) {
                this.gender = gender;
            }
            public Date getBirthday() {
                return birthday;
            }
            public void setBirthday(Date birthday) {
                this.birthday = birthday;
            }
            public String getPhone() {
                return phone;
            }
            public void setPhone(String phone) {
                this.phone = phone;
            }
            public String getAddress() {
                return address;
            }
            public void setAddress(String address) {
                this.address = address;
            }
            public Integer getUserRole() {
                return userRole;
            }
            public void setUserRole(Integer userRole) {
                this.userRole = userRole;
            }
            public Integer getCreatedBy() {
                return createdBy;
            }
            public void setCreatedBy(Integer createdBy) {
                this.createdBy = createdBy;
            }
            public Date getCreationDate() {
                return creationDate;
            }
            public void setCreationDate(Date creationDate) {
                this.creationDate = creationDate;
            }
            public Integer getModifyBy() {
                return modifyBy;
            }
            public void setModifyBy(Integer modifyBy) {
                this.modifyBy = modifyBy;
            }
            public Date getModifyDate() {
                return modifyDate;
            }
            public void setModifyDate(Date modifyDate) {
                this.modifyDate = modifyDate;
            }
        }

【注意】
在MyBatis中，不需要POJO类名与数据库表名一致，因为MyBatis是POJO与SQL语句之间的映射机制。

一般情况下，保证POJO对象的属性与数据库表的字段名一致即可。

接下来，继续进行SQL映射文件的创建，完成与POJO（实体类）的映射。

该文件也是一个XML文件，命名为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.smbms.dao.user.UserMapper">
            <!-- 查询用户表记录数 -->
            <select id="count" resultType="int">
                select count(1) as count from smbms_user
            </select>
        </mapper>

【经验】
SQL映射文件一般都对应于相应的POJO，所以一般都是采用POJO的名称+Mapper的规则来进行命名。
当然该mapper文件属于DAO层的操作，应该放置的dao包下，并根据业务功能进行分包放置。
如com.smbms.dao.user.UserMapper.xml。

上述示例代码UserMapper.xml中定义了SQL语句，其中各元素的含义如下：

mapper：映射文件的根元素节点，只有一个属性namespace。
- namespace：用于区分不同的mapper，全局唯一。
select：表示查询语句，是MyBatis最常用的元素之一，常用属性如下：
- id属性：该命名空间下唯一标识符；
- resultType属性：表示SQL语句返回值类型，此处通过SQL语句返回的是int数据类型。

五、创建测试类

在工程中加入jUnit4，创建测试类（UserMapperTest.java）进行功能测试，并在后台打印出用户表的记录数，具体实现步骤如下。

读取全局配置文件，mybatis-config.xml，如下代码所示：

        String resource = "mybatis-config.xml";
        // 获取mybatis-config.xml的输入流
        InputStream is = Resources.getResourceAsStream(resource);

创建SqlSessionFactory对象，此对象可以完成对配置文件的读取，如下所示：

        // 创建SqlSessionFactory对象，完成对配置文件的读取
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);

创建SqlSession对象，此对象的作用是调用mapper文件进行数据操作。
需要注意的是必须先把mapper文件引入到mybatis-config.xml中才能起效，如下所示：

        int count = 0;
        SqlSession sqlSession = null;
        sqlSession = factory.openSession();
        // MyBatis通过mapper文件的namespace和子元素的id来找到相应的SQL，从而执行查询操作
        count = sqlSession.selectOne("com.smbms.dao.user.UserMapper.count");
        logger.debug("UserMapperTest count---> " + count);

(4) 关闭SqlSessionFactory对象，如下所示：

        sqlSession.close();

【注意】
本教程中所有的项目案例以及练习，要求不再使用System.out.print进行后台日志的输出，一律使用log4j来实现日志的输出。
需要在resources目录下加入log4j.properties，并且在MyBatis的核心配置文件mybatis-config.xml中设置MyBatis的LOG实现为log4j。

resources/log4j.properties示例代码如下：

       log4j.rootLogger=DEBUG,CONSOLE,file
        #log4j.rootLogger=ERROR,ROLLING_FILE
        log4j.logger.cn.smbms.dao=debug
        log4j.logger.com.ibatis=debug 
        log4j.logger.com.ibatis.common.jdbc.SimpleDataSource=debug 
        log4j.logger.com.ibatis.common.jdbc.ScriptRunner=debug 
        log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate=debug 
        log4j.logger.java.sql.Connection=debug 
        log4j.logger.java.sql.Statement=debug 
        log4j.logger.java.sql.PreparedStatement=debug 
        log4j.logger.java.sql.ResultSet=debug 
        log4j.logger.org.tuckey.web.filters.urlrewrite.UrlRewriteFilter=debug
      ######################################################################################
        # Console Appender  \u65e5\u5fd7\u5728\u63a7\u5236\u8f93\u51fa\u914d\u7f6e
        ######################################################################################
        log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
        log4j.appender.Threshold=error
        log4j.appender.CONSOLE.Target=System.out
        log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
        log4j.appender.CONSOLE.layout.ConversionPattern= [%p] %d %c - %m%n
       ######################################################################################
        # DailyRolling File  \u6bcf\u5929\u4ea7\u751f\u4e00\u4e2a\u65e5\u5fd7\u6587\u4ef6\uff0c\u6587\u4ef6\u540d\u683c\u5f0f:log2009-09-11
        ######################################################################################
        log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
        log4j.appender.file.DatePattern=yyyy-MM-dd
        log4j.appender.file.File=log.log
        log4j.appender.file.Append=true
        log4j.appender.file.Threshold=error
        log4j.appender.file.layout=org.apache.log4j.PatternLayout
        log4j.appender.file.layout.ConversionPattern=%d{yyyy-M-d HH:mm:ss}%x[%5p](%F:%L) %m%n
        log4j.logger.com.opensymphony.xwork2=error

Undergoer_TW

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SSM框架开发应用（三）——MyBatis环境搭建

MyBatis环境搭建在MyEclipse中新建工程后，要使用MyBatis，需要做一下准备工作，如下图所示：一、下载所需的jar文件MyBatis的官方网站是http://mybatis.org，可以下载到最新Release版本的MyBatis。其他Release版本的MyBatis的jar文件都可以从官方网站下载得到。【注意】目前MyBatis官网在国内访问受限，若能访问到官网...
复制链接

扫一扫