servlet+mybatis 实现mysql的增删改查实例

古人云：温故而知新。趁周末，重新来学习了一遍servlet + mybatis 实现mysql的增删改查，算是对自己学习的一个总结和记录。

 

不难发现这是一个maven的项目结构。既然是maven项目，我们来看看使用servlet + mybatis 需要使用到哪些jar包，pom.xml文件代码如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.sunshine</groupId>
    <artifactId>ssm</artifactId>
    <packaging>war</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>ssm</name>
    <url>http://maven.apache.org</url>
    <!--设置版本信息-->
    <properties>
        <jdk.version>1.8</jdk.version>
        <slf4j.version>1.7.12</slf4j.version>
        <log4j.version>1.2.14</log4j.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>

        <!--log4j日志支持-->
        <!-- 日志文件管理包 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>${log4j.version}</version>
        </dependency>


        <!-- 格式化对象，方便输出日志 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.1.41</version>
        </dependency>


        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <!-- log end -->

        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.1</version>
        </dependency>

        <!--mysql 使用5.X版本-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>
        <!--servlet-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
        </dependency>



    </dependencies>
    <build>
        <finalName>ssm</finalName>
        <!--配置编译jdk版本-->
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

其中servlet使用到了一个包，连接mysql数据库需要用一个包，注意是使用5.X版本，mybatis也是使用到了一个包，除了这三个还导入到了log4j日志管理的相关包，以方便日志的输出和管理，log4j需要用到哪些包上面代码已标出。使用了log4j除了需要导入以上所示的jar包之外还需要在项目的支援文件夹（resources）中加入log4j.properties文件。代码如下：

log4j.rootLogger=DEBUG,Console,File

#定义日志输出目的地为控制台  
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.Target=System.out
#可以灵活地指定日志输出格式，下面一行是指定具体的格式  
log4j.appender.Console.layout = org.apache.log4j.PatternLayout
#log4j.appender.Console.layout.ConversionPattern=[%c] - %m%n
log4j.appender.Console.layout.ConversionPattern=[%p] [%d{yyyy-MM-dd HH\:mm\:ss}][%c] - %m%n

#文件大小到达指定尺寸的时候产生一个新的文件  
log4j.appender.File = org.apache.log4j.RollingFileAppender
#指定输出目录  
log4j.appender.File.File = logs/ssm.log
#定义文件最大大小  
log4j.appender.File.MaxFileSize = 10MB
# 输出所以日志，如果换成DEBUG表示输出DEBUG以上级别日志  
log4j.appender.File.Threshold = ALL
log4j.appender.File.layout = org.apache.log4j.PatternLayout
log4j.appender.File.layout.ConversionPattern =[%p] [%d{yyyy-MM-dd HH\:mm\:ss}][%c]%m%n

log4j.properties文件内容可以根据自己需要来进行不同的配置。配置完log4j文件后，开始进入本次的主题。

在资源文件夹下面配置mybatis-config.xml配置文件，配置文件内容如下：

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "mybatis-3-config.dtd">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://localhost:3306/shiro" />
                <property name="username" value="root" />
                <property name="password" value="1111" />
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="usersMapping.xml" />
    </mappers>
</configuration>

 

<mappers>
        <mapper resource="usersMapping.xml" />
</mappers>
这段代码就是设置了一个映射文件usersMapping.xml，这个映射文件我们在后面会讲到。我们先来看看这次需要进行增删改查的数据库：

使用了数据库shiro下的users表，其他的可以忽略。users表下有id,username,password,password_salt四个字段，这里要注意的是建表的时候，id要设置为自曾，如果是使用可视化工具，设置可参考如下图：

数据库创建完后，我们来创建users表对应的实体Users.java,代码如下：

package com.sunshine.bean;

import java.io.Serializable;

/**
 * Created by WH on 2016/12/3.
 */
public class Users implements Serializable {

    private static final long serialVersionUID = -8209492142737702621L;

    private int id;

    private String username;

    private String password;

    private String password_salt;

    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 getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getPassword_salt() {
        return password_salt;
    }

    public void setPassword_salt(String password_salt) {
        this.password_salt = password_salt;
    }

    @Override
    public String toString() {
        return "Users{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", password_salt='" + password_salt + '\'' +
                '}';
    }
}

创建好实体后，开始创建myatis的sqlSession工厂类，用于获得SqlSessionFactory，GetSqlSessionFactory.java类代码如下：

package com.sunshine.util;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.io.InputStream;

/**
 * Created by WH on 2016/12/3.
 *
 * 使用单例模式获取SqlSessionFactory
 */
public class GetSqlSessionFactory {

    private static final Logger LOGGER = LoggerFactory.getLogger(GetSqlSessionFactory.class);

    private static SqlSessionFactory sqlSessionFactory;

    /**
     * 私有构造方法，使该类不可创建新对象
     */
    private GetSqlSessionFactory(){

    }

    /**
     * 使用同步锁
     * @return sql session 工厂
     */
    synchronized public static SqlSessionFactory getSqlSessionFactory(){
        if (sqlSessionFactory == null){
            //获取资源文件流
            String resorce = "mybatis-config.xml";
            InputStream inputStream = null;
            try {
                inputStream = Resources.getResourceAsStream(resorce);
            } catch (IOException e) {
                LOGGER.error("Get Resource Error:", e);
            }
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        }
        return sqlSessionFactory;
    }

}

获取sqlSessionFactory使用单例模式。因为一旦创建SqlSessionFactory对象后，该对象应该在应用的整个执行中都需要存在，不必要每次获取一次sqlSession都需要创建一次session工厂对象，所以这里最佳的方式就是写一个单利模式。创建SqlSessionFactory对象后，我们来通过该对象获得SqlSession。获得SqlSession我们写在另外一个类中GetSqlSession.java，代码如下：

package com.sunshine.util;

import org.apache.ibatis.session.SqlSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Created by WH on 2016/12/3.
 */
public class GetSqlSession {

    private static final Logger LOGGER = LoggerFactory.getLogger(GetSqlSession.class);

    private static ThreadLocal<SqlSession> tl = new ThreadLocal<SqlSession>();

    /**
     * 获取SqlSession
     * @return sqlSession
     */
    public static SqlSession getSqlSession(){
        SqlSession sqlSession = tl.get();
        if (sqlSession == null){
            sqlSession = GetSqlSessionFactory.getSqlSessionFactory().openSession();
            tl.set(sqlSession);
        }
        LOGGER.info("Get SqlSession hashCode : {}." , sqlSession.hashCode());
        return sqlSession;
    }

    /**
     *  提交事物
     */
    public static void commit(){
        if (tl.get() != null){
            tl.get().commit();
            tl.get().close();
            tl.set(null);
            LOGGER.info("SqlSession commit.");
        }
    }

    /**
     *  回滚事务
     */
    public static void rollback(){
        if (tl.get() != null){
            tl.get().rollback();
            tl.get().close();
            tl.set(null);
            LOGGER.info("SqlSession rollback.");
        }
    }

}

这个类中主要有三个方法，一个是获取SqlSession，一个是用于增删改查完成后提交事务，一个是用于增删改查错误后回滚事务，以免数据库产生脏数据。以上的这一切都准备好后我们开始来写servlet类，先来一个查询类GetUsersServlet.java代码如下：

package com.sunshine.servlet;

import com.sunshine.bean.Users;
import com.sunshine.util.GetSqlSession;
import org.apache.ibatis.session.SqlSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * Created by WH on 2016/12/3.
 */
@WebServlet(name = "GetUsersServlet", value = "/getUsersById")
public class GetUsersServlet extends javax.servlet.http.HttpServlet {

    private static final Logger LOGGER = LoggerFactory.getLogger(GetUsersServlet.class);

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        this.doGet(request, response);
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        Users users = null;
        try {
            SqlSession sqlSession = GetSqlSession.getSqlSession();
            users = sqlSession.selectOne("users.sql.getUsersById", 3);
        } catch (Exception e) {
            LOGGER.error("select error", e);
            GetSqlSession.rollback();
        } finally {
            GetSqlSession.commit();
        }
        System.out.println(users.toString());
    }
}

这里需要注意的是@WebServlet(name = "GetUsersServlet", value = "/getUsersById")一定要写上value并给value赋值，这是通过浏览器访问这个类的路径，所以千万别忘记了。写到这里似乎少了些什么，代码中也出现了一段让人难以理解的代码：

users = sqlSession.selectOne("users.sql.getUsersById", 3);

嗯，对。"users.sql.getUsersById"这就是前面提到的在mybatis-config.xml配置文件中的映射文件usersMapping.xml，我们来看看这映射文件写了什么：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "mybatis-3-mapper.dtd">
<mapper namespace="users.sql">
    
    <!--查询Sql-->
    <select id="getUsersById" parameterType="int" resultType="com.sunshine.bean.Users">
        select * from
        users where id = #{id}
    </select>

    <!--新增-->
    <insert id="insertUsers" parameterType="com.sunshine.bean.Users"
            useGeneratedKeys="true" keyProperty="id">
        insert into
        users(username, password, password_salt)
        values(#{username}, #{password}, #{password_salt})
    </insert>

    <!--删除-->
    <delete id="deleteUsersById" parameterType="int">
        delete from
        users where id=#{id}
    </delete>

    <!--更新-->
    <update id="updateUsersById" parameterType="com.sunshine.bean.Users">
        update users
        set
        username=#{username},password=#{password},password_salt=#{password_salt}
        where id=#{id}
    </update>
</mapper>

这里我们要注意的是映射文件中的<mapper namespace="users.sql">这段代码和各查询、新增、删除和更新Sql的id。看了这些我们就不难理解刚刚让我们难以理解的句代码users = sqlSession.selectOne("users.sql.getUsersById", 3);了，表示的就是使用了namespace="users.sql"中的查询sql。

到这里，前期的所有工作也基本完成，我们开始启动程序，启动好程序后在浏览器输入http://localhost:8082/ssm/getUsersById请求我们刚刚的写的servlet类GetUsersServlet.java。看看控制台发生了什么：

 

数据库数据：

 

 查询结果正确。

数据查询出来，我们来新增个数据，新增数据的servlet类InsertUsersServlet.java代码如下：

package com.sunshine.servlet;

import com.sunshine.bean.Users;
import com.sunshine.util.GetSqlSession;
import com.sunshine.util.GetSqlSessionFactory;
import org.apache.ibatis.session.SqlSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * Created by WH on 2016/12/3.
 */
@WebServlet(name = "InsertUsersServlet", value = "/insertUsers")
public class InsertUsersServlet extends HttpServlet {

    private static final Logger LOGGER = LoggerFactory.getLogger(GetSqlSessionFactory.class);

    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        this.doGet(request, response);
    }

    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        Users users = new Users();
        users.setUsername("liu");
        users.setPassword("123456");
        try {
            SqlSession sqlSession = GetSqlSession.getSqlSession();
            sqlSession.insert("users.sql.insertUsers", users);
            System.out.println("新增成功！新增id为：" + users.getId());
        } catch (Exception e){
            GetSqlSession.rollback();
            LOGGER.error("insert error", e);
        } finally {
            GetSqlSession.commit();
        }
    }
}

 

看数据库是否真插入成功：

至此已完成了查询和新增，修改删除读者可自己验证。修改片段代码如下：

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        Users users = new Users();
        SqlSession sqlSession = GetSqlSession.getSqlSession();
        try {
            users = sqlSession.selectOne("users.sql.getUsersById", 3);
        } catch (Exception e) {
            LOGGER.error("select error", e);
            GetSqlSession.rollback();
        }

        System.out.println(users.toString());

        users.setUsername("WeiHong");

        try {
            sqlSession.update("users.sql.updateUsersById", users);
        } catch (Exception e) {
            LOGGER.error("updateUsersById error", e);
            GetSqlSession.rollback();
        } finally {
            GetSqlSession.commit();
        }

    }

删除部分代码如下：

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        SqlSession sqlSession = GetSqlSession.getSqlSession();
        try {
            sqlSession.delete("users.sql.deleteUsersById", 4);
        } catch (Exception e) {
            LOGGER.error("delete error", e);
            GetSqlSession.rollback();
        } finally {
            GetSqlSession.commit();
        }
    }

至此，servlet+mybatis 实现mysql的增删改查实例已经完成。