SpringMVC+Mybatis典型配置

一、配置web.xml文件

在web.xml文件中，主要配置springservlet、mybatis、网页中文编码等内容

<web-app 
    id="WebApp_ID" 
    version="3.0" 
    xmlns="http://java.sun.com/xml/ns/j2ee" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
    http://java.sun.com/xml/ns/j2ee/web-app_3_0.xsd">

    <display-name>Spring MVC Form Handling</display-name>  

    <!--1.  servlet配置 -->
    <servlet>    
        <!--
            （1） servlet名称 
            （2） servlet类名
            （3）加载servlet的时机，1表示服务器启动时加载
            （4）servlet配置文件的位置
        -->    
        <servlet-name>HelloSpringWeb</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
        <!--contextConfigLocation配置springmvc加载的配置文件（配置处理器映射器、适配器等等) 如果不配置contextConfigLocation,默认加载的是/WEB-INF/servlet名称-serlvet.xml(springmvc-servlet.xml) --> 
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/config/springmvcConfig.xml</param-value>
        </init-param>
    </servlet>

    <!-- 2. servlet拦截地址配置 -->
    <servlet-mapping>
        <!-- 
            （1）servlet名称 ,要与前面的名称保持一致
            （2）拦截地址
        -->
        <servlet-name>HelloSpringWeb</servlet-name>
        <!-- servlet对应的地址空间 
               第一种：*.action，访问以.action结尾由DispatcherServlet进行解析
               第二种：/，所以访问的地址都由DispatcherServlet进行解析，对于静态文件的解析需要配置不让DispatcherServlet进行解析使用此种方式可以实现RESTfu1风格的ur1
               第三种：/*，这样配置不对，使用这种配置，最终要转发到一个jsp页面时，  然会由DispatcherServlet解析jsp地址，不能根据jsp页面找到handler，会报错。
        -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    
    
    <!-- 3. mybatis配置 -->
    <!-- （1）参数文件位置 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/config/mybatisConfig.xml</param-value>
    </context-param>
    <!-- （2）加载参数文件的监听器 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <!-- 4. 页面编码配置 -->
    <filter>        
        <!-- 
            （1）设置编码类型
            （2）是否强制编码
         -->
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <!-- encoding=UTF-8 -->
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <!-- forceEncoding=true -->
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>

</web-app>

 

二、配置SpringMVC文件

在springmvcConfig.xml文件中主要做 扫描配置、注解配置、视图配置、静态资源配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context" 
    xmlns:jdbc="http://www.springframework.org/schema/jdbc"  
    xmlns:jee="http://www.springframework.org/schema/jee" 
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:aop="http://www.springframework.org/schema/aop" 
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xmlns:util="http://www.springframework.org/schema/util"
    xmlns:jpa="http://www.springframework.org/schema/data/jpa"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd
        http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-3.2.xsd
        http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-3.2.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.2.xsd
        http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa-1.3.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.2.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
        http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.2.xsd">

    <!-- 1. 扫描配置
        自动扫描的包名，包括controller，service等，是这些子包的父包，因此可合并文com.gs 
    -->
    <context:component-scan base-package="com.gs.controller, com.gs.service" />

    <!-- 2. 注解配置
        默认的注解映射的支持
     -->
    <mvc:annotation-driven />

    <!-- 3. 视图配置
        （1）前缀
        （2）后缀
     -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 视图前缀 -->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <!-- 视图后缀 -->
        <property name="suffix" value=".jsp" />
    </bean>
    

    <!-- 4. 静态资源文件配置
        （1）在url路径中包含/images/**这样的请求不会被拦截，并对应的目录为/WEB-INF/static/images/
        （2）** 表示可以带子目录 
    -->
    <mvc:resources mapping="/images/**" location="/WEB-INF/static/images/" />
    <mvc:resources mapping="/js/**" location="/WEB-INF/js/" />
    <mvc:resources mapping="/css/**" location="/WEB-INF/css/" />

</beans>

 

三、配置Mybatis文件

mybatisConfig.xml文件主要配置 数据库属性文件配置、数据库Datasource配置、会话配置、扫描数据读写接口配置、数据库事务配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context" 
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
    xsi:schemaLocation="http://www.springframework.org/schema/beans  
    http://www.springframework.org/schema/beans/spring-beans-3.1.xsd  
    http://www.springframework.org/schema/context  
    http://www.springframework.org/schema/context/spring-context-3.1.xsd  
    http://www.springframework.org/schema/mvc  
    http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
    http://mybatis.org/schema/mybatis-spring
    http://mybatis.org/schema/mybatis-spring.xsd">

    <!--1. 数据库属性文件配置
        引入属性文件，在配置中占位使用 
    -->
    <context:property-placeholder location="/WEB-INF/config/db.properties" />

    <!--2. 数据库datasource配置
        driverClass、url、user、password是必须配置的
     -->
    <bean id="datasource" class="com.mchange.v2.c3p0.ComboPooledDataSource" destroy-method="close">
        <!--驱动类名 -->
        <property name="driverClass" value="${jdbc.driver}" />
        <!-- url -->
        <property name="jdbcUrl" value="${jdbc.url}" />
        <!-- 用户名 -->
        <property name="user" value="${jdbc.user}" />
        <!-- 密码 -->
        <property name="password" value="${jdbc.password}" />
        <!-- 当连接池中的连接耗尽的时候c3p0一次同时获取的连接数 -->
        <property name="acquireIncrement" value="5"></property>
        <!-- 初始连接池大小 -->
        <property name="initialPoolSize" value="10"></property>
        <!-- 连接池中连接最小个数 -->
        <property name="minPoolSize" value="5"></property>
        <!-- 连接池中连接最大个数 -->
        <property name="maxPoolSize" value="20"></property>
    </bean>

    <!--3. 会话配置 
        会话的数据源引用上面设置的datasource
    -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="datasource"></property>
    </bean>

    <!--4. 扫描数据读写接口 -->
    <mybatis:scan base-package="com.gs.mapper"/>

    <!--5 声明式事务管理 -->
    <!--定义事物管理器，由spring管理事务 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="datasource"></property>
    </bean>

</beans>

 db.properties文件的内容如下

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.user=root
jdbc.password=root

 

四、编写实体类

实体类是数据的载体，是数据格式的体现。User.java文件内容如下

package com.gs.entity;

public class User
{
    /*
     * 属性名，私有成员变量
     */
    private String name;
    private String password;
    
    /*
     * setter 和 getter      
     */
    public String getName()
    {
        return name;
    }
    public void setName(String name)
    {
        this.name = name;
    }
    public String getPassword()
    {
        return password;
    }
    public void setPassword(String password)
    {
        this.password = password;
    }
    
}

 

五、编写Mapper接口和SQL

 mapper接口是实现数据库数据读写的工具，要配合SQL的xml文件使用。

（1）java文件

UserMapper.java接口文件内容如下：

 

package com.gs.mapper;

import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Update;

import com.gs.entity.User;

public interface UserMapper
{
    /*
     * 使用@Param(参数名) 可以将传递的参数之间映射到sql语句的同名参数上，xml中可以不指定parameterType
     */
    public User getUser(@Param("name") String name,  @Param("password") String password);
    
    /*
     * 不使用@Param注释，则要在xml中指定parameterType，如果是类类型，则sql参数会自动对应同名的类属性
     */
    public void insertUser(User user);
    public void deleteUser(User user);
    
    /*
     * 下面这个例子说明，不写xml文件也可以，但是要使用mybatis的注解@Update
     */
    @Update("update user set password = #{password} where name = #{name}")
    public void updateUser(User user);
}

 

（2）xml文件

在UserMapper.java相同目录下，编写UserMapper.xml，对应接口方法用到的SQL语句，内容如下：

<?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.gs.mapper.UserMapper">
    <select id="getUser" resultType="com.gs.entity.User" >
        <!-- 语句中name和password参数自动与接口的参数对应，返回值为User对象 -->
        select name, password from user where name=#{name} and password=#{password}
    </select>    
    
    <insert id="insertUser" parameterType="com.gs.entity.User">
        <!-- 传递进来的是User类型，sql语句中的参数会自动对应 -->
        insert into user values(#{name}, #{password})
    </insert>    
    
    <delete id="deleteUser" parameterType="com.gs.entity.User">
        delete from user where name=#{name} 
    </delete>
</mapper>

 

六、编写服务接口和实现类

服务接口与具体的业务相关， 在实现类中可以包含多Mapper接口，在业务逻辑过程中实现各类数据的读写

可以不写服务接口，直接写服务接口实现类，UserService.java文件内容如下：

 

package com.gs.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.gs.entity.User;
import com.gs.mapper.UserMapper;

/* 注解 服务类
 *  格式 @Service(value="名称")
 *  该名称将在控制器中引用 
 */
@Service
public class UserService
{
    /*
     * 自动装配userMapper
     */
    @Autowired
    UserMapper userMapper;
    
    public User getUser(String name, String password)
    {
        System.out.println("enter service");
        return userMapper.getUser(name, password);
    }
    
    public void insertUser(String name, String password)
    {
        System.out.println("insert user");
        User user = new User();
        user.setName(name);
        user.setPassword(password);
        userMapper.insertUser(user);
    }
    
    public void deleteUser(String name, String password)
    {
        System.out.println("delete user");
        User user = new User();
        user.setName(name);
        userMapper.deleteUser(user);        
    }
}

 

七、编写控制器

浏览器提交的url传递到web服务器后，首先被分配器拦截，分配器根据请求url找到相应的控制器，控制器根据请求url进一步找到请求的方法，在请求方法中编写返回浏览器的内容

 

package com.gs.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import com.gs.entity.User;
import com.gs.mapper.UserMapper;
import com.gs.service.UserService;
import com.sun.swing.internal.plaf.basic.resources.basic;

/*
 * 控制器以@Controller开头
 * 每个类名就是一个控制器
 * 控制器中有很多方法，对应着各种url请求
 * 控制器下面还可以带@RequestMapping，表示url请求路径在主路径下的子路径
 */
@Controller
@RequestMapping(value = "/user")
public class LoginController
{
    
    /*
     * 自动装配 @Autowired，就是在控制器类中定义的成员变量，不必自己实例化，而是由spring创建bean来装配
     * 前提条件是，在配置xml文件时要指定扫描的bean所在的包或父包， 如
     * <context:component-scan base-package="com.gs.service, com.gs.mapper"/>
     */
    @Autowired
    UserService userservice;
    
    @Autowired
    UserMapper userMapper;
    
    /*
     * 时间请求路径为ip:port/项目名/user/login，GET方法表示是地址栏的请求
     */
    @RequestMapping(value = "/login", method = RequestMethod.GET)
    public String login()
    {
        /*
         * 返回WEB-INF/jsp/user/login.jsp文件，具体请看springmvc配置中的前缀和后缀配置
         */
        return "user/login";
    }
    
    /*
     * POST方法表示是表单的请求
     */
    @RequestMapping(value = "/loginUser", method = RequestMethod.POST)
    public String loginUser(HttpServletRequest request, HttpServletResponse response)
    {
        String name = request.getParameter("name");
        String password = request.getParameter("password");
        if (userservice.getUser(name, password) == null)
        {
            System.out.println("not found this user!");
            return "user/error";
        }
        else 
        {
            System.out.println("found this user!");
            return "user/ok";
        }
    }
    
    @RequestMapping(value = "/insert", method = RequestMethod.GET)
    public String insertUser()
    {
        return "user/insert";
    }
    
    @RequestMapping(value = "/insertUser", method = RequestMethod.POST)
    public String insertUser(HttpServletRequest request, HttpServletResponse response)
    {
        String name = request.getParameter("name");
        String password = request.getParameter("password");
        userservice.insertUser(name, password);
        return "user/ok";
    }
    
    @RequestMapping(value="/delete", method = RequestMethod.GET)
    public String deleteUser()
    {
        return "user/delete";
    }
    
    @RequestMapping(value="/deleteUser", method = RequestMethod.POST)
    public String deleteUser(HttpServletRequest request, HttpServletResponse response)
    {
        User user = new User();
        user.setName(request.getParameter("name"));
        user.setPassword(request.getParameter("password"));
        /*
         * 这个例子说明，既可以调用service来实现功能，也可以直接调用mapper来实现功能
         */
        userMapper.deleteUser(user);
        return "user/ok";
    }
    
    @RequestMapping(value="/update", method = RequestMethod.GET)
    public String updateUser()
    {
        return "user/update";
    }
    
    @RequestMapping(value="/updateUser", method = RequestMethod.POST)
    public String updateUser(HttpServletRequest request, HttpServletResponse response)
    {
        User user = new User();
        user.setName(request.getParameter("name"));
        user.setPassword(request.getParameter("password"));
        userMapper.updateUser(user);
        return "user/ok";
    }
}

 八、编写jsp文件

 jsp文件存放在WEB-INF/jsp/user目录下，包括login.jsp, insert.jsp, update.jsp, delete.jsp, ok.jsp, error.jsp等文件，login.jsp文件内容如下：

 

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>
    <h2>Student Information</h2>
    <form method="POST" action="/HelloWeb/user/loginUser">
        <table>
            <tr>
                <td colspan="2"><img src="../images/user/user2.jpg" width="200" height="200"> </td>
            </tr>
            <tr>
                <td><label>Name</form:label></td>
                <td><input name="name" /></td>
            </tr>
            <tr>
                <td><label >Password</form:label></td>
                <td><input name="password" /></td>
            </tr>

            <tr>
                <td colspan="2"><input type="submit" value="Submit" /></td>
            </tr>
        </table>
    </form>
</body>
</html>

 九、依赖的jar

依赖的jar包括springmvc、mybatis和mysql驱动等，如下图所示：