Spring入门，一步一步搭建入门Spring Web应用

如何快速搭建一个入门的Spring Web应用？

• 开发工具：IDEA 2017
• 环境准备：Maven 3.3，jdk 1.7，mysql 5.5
• 一步一步搭建一个完整的Spring Web应用，实例应用按持久层、业务层、展现层进行组织。需求就是实现一个简单的用户登录验证与登录信息更新。

一、 环境准备

本实例的工程代码会放在 D:\masterSpring\code 文件夹下面。

1.Maven

Maven安装目录：D:\masterSpring\apache-maven-3.5.0
配置Maven环境变量:

• 新建“MAVEN_HOME”环境变量：D:\masterSpring\apache-maven-3.5.0
• 编辑“Path”环境变量：把%MAVEN_HOME%\bin添加到当前环境变量
• 在命令行窗口输入“mvn -v”能看到Maven和jdk版本号即ok

2.数据库

数据库名称：sampledb
数据库表：

• 用户表：t_user(user_id int 主键，user_name varchar(32),credits int,password varchar(32),last_visit datetime,last_ip varchar(32))设置主键自增长
• 登录日志表：t_login_log(login_log_id int 主键,user_id int,ip varchar(32),login_datetime datetime)设置主键自增长
• 插入一条数据到用户表(‘admin’,’123456’)

二、 创建工程

IDEA创建Maven工程(按照本实例要求创建的)

三、 持久层实现

包结构规划：

• 主程序包规划

• 测 试 包 规划

持久层负责数据的访问和操作，DAO类被上层的业务类调用。这里使用Spring JDBC作为持久层的实现技术。

1.创建领域对象

领域对象（Domain Object）也被成为实体类，它代表了业务的状态，贯穿展现层、业务层、持久层，并最终被持久化到数据库中，领域对象往往拥有对应的数据库表（也可以理解为领域对象里面的属性对应数据库表的字段）。持久层的主要工作是从数据库中加载数据并实例化领域对象。

登录验证实例需要涉及两个领域对象：User（用户信息）对应t_user表和LoginLog（日志信息）对应t_login_log表。领域对象包为com.smart.domain。

User.java领域对象

package com.smart.domain;

import java.io.Serializable;
import java.util.Date;
/** * Created by Mistra.WR on 2017/8/5/005. */
//领域对象一般要实现Serializable接口，以便可以序列化
public class User implements Serializable{
    private int userID;
    private String username;
    private String password;
    private int credits;
    private String lastIp;
    private Date lastVisit;
    //省略get/set方法
}

LoginLog.java领域对象

package com.smart.domain;

import java.io.Serializable;
import java.util.Date;
/** * Created by Mistra.WR on 2017/8/5/005. */
public class LoginLog implements Serializable{
    private int loginLogid;
    private int userId;
    private String ip;
    private Date loginDate;
}

2.UserDao

package com.smart.dao;
import com.smart.domain.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowCallbackHandler;
import org.springframework.stereotype.Repository;

import java.sql.ResultSet;
import java.sql.SQLException;
/** * Created by Mistra.WR on 2017/8/5/005. */
@Repository //通过Spring注解定义一个DAO
public class UserDao {
    private JdbcTemplate jdbcTemplate;
    private final static String MATCH_COUNT_SQL =  "select count(*) from t_user"
            + " where user_name = ? and password=?";
    private final static String UPDATE_LOGININFO_SQL = "update t_user set "+
            " last_visit=?,last_ip=?,credits=? where user_id=?";
    @Autowired //自动注入JdbcTemplate的bean
    public void setJdbcTemplatedbcTemplate(JdbcTemplate jdbcTemplate){
        this.jdbcTemplate = jdbcTemplate;
    }
    public int getMatchCount(String userName,String password){//根据用户名密码获取匹配的用户数
        return jdbcTemplate.queryForObject(MATCH_COUNT_SQL,new Object[]{userName,password}, Integer.class).intValue();
    }

    public User findUserByUserName(final String userName){//根据用户名获取User对象
        String sqlStr = " SELECT user_id,user_name,credits "
                + " FROM t_user WHERE user_name =? ";
        final User user = new User();
        jdbcTemplate.query(sqlStr, new Object[]{userName},
                new RowCallbackHandler() {//匿名类方式实现的回调函数
                    public void processRow(ResultSet resultSet) throws SQLException {
                        user.setUserID(resultSet.getInt("user_id"));
                        user.setUsername(userName);
                        user.setCredits(resultSet.getInt("credits"));
                    }
                }
        );
        return user;
    }
    public void updateLoginInfo(User user){//更新用户积分、最后登录时间和IP
        jdbcTemplate.update(UPDATE_LOGININFO_SQL,new Object[]{user.getLastVisit(),user.getLastIp(),user.getCredits(),user.getUserID()});
    }
} 

关于findUserByUserName()方法中的JdbcTemplate.query(String sqlStr，Object[] args,RowCallbackHandler rch)方法：

• sqlStr:查询的SQL语句，允许使用带”?”的参数占位符
• args:SQL语句中占位符对应的参数数组
• RowCallbackHandler ：查询结果的处理回调接口，该回调接口有一个processRow(ResultSet rs)方法，负责将查询结果从ResultSet 装载到类似于领域对象的对象实例中。此处即将ResultSet转换成User对象。

3.LoginLogDao

package com.smart.dao;

import com.smart.domain.LoginLog;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;
/** * Created by Mistra.WR on 2017/8/9/009. */
@Repository
public class LoginLogDao {
    private JdbcTemplate jdbcTemplate;

    //保存登陆日志
    private final static String INSERT_LOGIN_LOG_SQL = "insert into t_login_log(user_id,ip,login_datetime)" +
            " values(?,?,?)";
    public void insertLoginLog(LoginLog loginLog){
        jdbcTemplate.update(INSERT_LOGIN_LOG_SQL,new Object[]{loginLog.getUserId(),loginLog.getIp(),loginLog.getLoginDate()});
    }
@Autowired
    public void setJdbcTemplate(JdbcTemplate jdbcTemplate){
        this.jdbcTemplate=jdbcTemplate;
    }
}

4.在Spring中装配Dao

JdbcTemplate本身需要一个DataSource，才能从DataSource中获取或返回连接。UserDao和LoginLogDao都提供了一个带@Autowired注解的JdbcTemplate变量，所以我们必须事先声明一个数据源，然后定义一个JdbcTemplate Bean，通过Spring的容器上下文自动绑定机制进行Bean注入。

在src/resources目录下创建一个smart-context.xml的Spring配置文件。(Maven工程中，资源文件统一放置在resources文件夹中)

<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:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" 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/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd">

    
    <context:component-scan base-package="com.smart.dao"/>

    
    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close" p:driverClassName="com.mysql.jdbc.Driver" p:url="jdbc:mysql://localhost:3306/sampledb" p:username="root" p:password="123456" />

    
    <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate" p:dataSource-ref="dataSource" />
beans>

四、 业务层实现

1.UserService

UserService负责将持久层的UserDao和LoginLoginDao组织起来，完成用户/密码验证、登录日志记录等操作。

UserService.java

package com.smart.service;

import com.smart.dao.LoginLogDao;
import com.smart.dao.UserDao;
import com.smart.domain.LoginLog;
import com.smart.domain.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

/** * Created by Mistra.WR on 2017/8/10/010. */
@Service//将UserService标注为一个服务层的Bean
public class UserService {
    private UserDao userDao;
    private LoginLogDao loginLogDao;

    @Autowired//注入userDao Bean
    private void setUserDao(UserDao userDao){
        this.userDao = userDao;
    }

    @Autowired//注入loginLogDao Bean
    private void setLoginLogDao(LoginLogDao loginLogDao){
        this.loginLogDao = loginLogDao;
    }

    public boolean hasMatcherUser(String username,String password){
        int matchCount = userDao.getMatchCount(username,password);
        return matchCount > 0;
    }

    public User findUserByUserName(String username){
        return userDao.findUserByUserName(username);
    }

    @Transactional//标注事物注解，让该方法运行在事物环境中
    public void loginSuccess(User user){
        user.setCredits( 5 + user.getCredits());
        LoginLog loginLog = new LoginLog();
        loginLog.setIp(user.getLastIp());
        loginLog.setUserId(user.getUserID());
        loginLog.setLoginDate(user.getLastVisit());
        userDao.updateLoginInfo(user);
        loginLogDao.insertLoginLog(loginLog);
    }
}

2.在Spring中装配Service

打开原来的smart-context.xml文件，添加如下配置

    
    <context:component-scan base-package="com.smart.service"/>
    
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager" p:dataSource-ref="dataSource" />

    
    <aop:config proxy-target-class="true">
        <aop:pointcut id="serviceMethod" expression="(execution(* com.smart.service..*(..))) and (@annotation(org.springframework.transaction.annotation.Transactional))" />
        <aop:advisor pointcut-ref="serviceMethod" advice-ref="txAdvice" />
    aop:config>
    <tx:advice id="txAdvice" transaction-manager="transactionManager">
        <tx:attributes>
            <tx:method name="*" />
        tx:attributes>
    tx:advice>

①处将com.smart.service添加到上下文扫描路径中，以便service包中类的Spring注解生效。
②处定义了一个基于数据源的DataSourceTransactionManager事务管理器，该事物管理器负责声明式事务的管理。该管理器需要引用dataSource Bean
③处以AOP的方式为com.smart.service包下所有类的所有标注@Transactional注解的方法都添加了事务增强，即它们都将工作在事务环境中。

3.单元测试

单元测试采用TestNG框架，确保下面的TestNG依赖包添加到了你的pom.xml文件中。

        <dependency>
            <groupId>org.testnggroupId>
            <artifactId>testngartifactId>
            <version>${testng.version}version>
            <scope>testscope>
        dependency>
        <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-testartifactId>
            <version>${spring.version}version>
            <scope>testscope>
        dependency>

在src/test/java/com.smart/service包下面新建UserServiceTest.java

UserServiceTest.java

package com.smart.service;

import java.util.Date;
import org.springframework.test.context.testng.AbstractTransactionalTestNGSpringContextTests;
import org.testng.annotations.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import com.smart.domain.User;
import static org.testng.Assert.*;

@ContextConfiguration("classpath*:/smart-context.xml")//启动spring容器
public class UserServiceTest extends AbstractTransactionalTestNGSpringContextTests {

    @Autowired
    private UserService userService;

    @Test//标注测试方法
    public void testHasMatchUser() {
        boolean b1 = userService.hasMatcherUser("admin", "123456");
        boolean b2 = userService.hasMatcherUser("admin", "1111");
        assertTrue(b1);//判断一个条件是true还是false
        assertTrue(!b2);
    }

    @Test
    public void testFindUserByUserName()throws Exception{
        for(int i =0; i< 100;i++) {
            User user = userService.findUserByUserName("admin");
            assertEquals(user.getUsername(), "admin");// 判断是否相等，可以指定输出错误信息。第一个参数是期望值，第二个参数是实际的值
        }
    }

    @Test
    public void testAddLoginLog() {
        User user = userService.findUserByUserName("admin");
        user.setUserID(1);
        user.setUsername("admin");
        user.setLastIp("192.168.12.7");
        user.setLastVisit(new Date());
        userService.loginSuccess(user);
    }
}

在IDEA中执行当前测试类，通过右键菜单Run ‘UserServiceTest’来运行该测试用例。

看到三个方法已经成功执行。在数据库可以看到t_login_log表增加了一条日志数据。

五、 展现层实现

1.配置Spring MVC框架

打开webapp/WEB-INF/web.xml文件，增加Spring MVC配置

<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  
  <context-param>
    <param-name>contextConfigLocationparam-name>
    <param-value>classpath:smart-context.xmlparam-value>
  context-param>
  
  <listener>
    <listener-class>
      org.springframework.web.context.ContextLoaderListener
    listener-class>
  listener>

  
  <servlet>
    <servlet-name>smartservlet-name>
    <servlet-class>
      org.springframework.web.servlet.DispatcherServlet
    servlet-class>
    <load-on-startup>3load-on-startup>
  servlet>

  <servlet-mapping>
    <servlet-name>smartservlet-name>
    <url-pattern>*.htmlurl-pattern>
  servlet-mapping>
web-app>

①处多个配置文件可用逗号分隔
②处的Web容器监听器会在Web容器启动时自动运行，它会根据contextConfigLocation Web容器参数获取Spring配置文件，并启动Spring容器。
③处Servlet映射，这里让所有以*.html为后缀的URL都能被smart Servlet截获，进而转由Spring MVC框架进行处理。请求被Spring MVC截获后，首先根据请求的URL查找到目标的处理控制器，并将请求参数封装到对象中（或者封装到入参字段中），交给控制器处理。

2.登录控制器

请求命令对象LoginCommand.java

package com.smart.web;

/** * Created by Mistra.WR on 2017/8/14/014. */
public class LoginCommand {
    private String username;
    private String password;
    //省略了get/set方法
}

登录控制器LoginController.java

package com.smart.web;

import com.smart.domain.User;
import com.smart.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import java.util.Date;

/** * Created by Mistra.WR on 2017/8/14/014. */
@Controller//①标注成为一个Spring MVC的Controller
public class LoginController {
    private UserService userService;

    @Autowired
    public void setUserService(UserService userService){
        this.userService = userService;
    }

    //②负责处理/index.html的请求
    @RequestMapping(value = "/index.html")
    public String loginPage(){
        return "login";
    }
    //③负责处理/loginCheck.html的请求
    @RequestMapping(value = "/loginCheck.html")
    public ModelAndView loginCheck(HttpServletRequest request,LoginCommand loginCommand){
        boolean isValidUser = userService.hasMatcherUser(loginCommand.getUsername(),loginCommand.getPassword());
        if (!isValidUser){
            return new ModelAndView("login","error","用户名或密码错误");//④
        }else{
            User user = userService.findUserByUserName(loginCommand.getUsername());
            user.setLastIp(request.getLocalAddr());
            user.setLastVisit(new Date());
            userService.loginSuccess(user);
            request.getSession().setAttribute("user",user);
            return new ModelAndView("main");
        }
    }    
}

请求参数会根据参数名称默认契约自动绑定到相应方法的入参中。在③处请求参数会按照名称匹配绑定到loginCommand的入参中。
请求响应方法可以返回一个ModelAndView，或直接返回一个字符串，Spring MVC会解析之并转向目标页面。
ModelAndView对象既包括视图信息，又包括视图渲染所需的模型数据信息。
在④处ModelAndView(“login”,”error”,”用户名或密码错误”);第一个参数代表视图的逻辑名，第二个参数代表数据模型名，第三个参数代表数据模型对象，数据模型对象将以数据模型名称为参数名放置到request的属性中。

3.Spring MVC配置文件

在webapp/WEB-INF文件夹下新建Spring MVC配置文件smart-servlet.xml

<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" 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">
    
    <context:component-scan base-package="com.smart.web"/>
    
    <bean  class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:viewClass="org.springframework.web.servlet.view.JstlView" p:prefix="/WEB-INF/jsp/" p:suffix=".jsp" />
beans>

①处配置的视图解析器，它通过为视图逻辑名添加前、后缀的方式进行解析。如逻辑名为”login”，将解析为“/WEB-INF/jsp/login.jsp”。

4.JSP视图页面

登录页面login.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<html>
    <head>
        <title>登录title>
    head>
    <body>
        <c:if test="${!empty error}">
            <font color="red"><c:out value="${error}" />font>
        c:if>
        <form action="loginCheck.html"/>" method="post">
            用户名：
            <input type="text" name="username">
            <br>
            密 码：
            <input type="password" name="password">
            <br>
            <input type="submit" value="登录" />
            <input type="reset" value="重置" />
        form>
    body>
html>

login.jsp页面既作为登录页面，又作为登录失败之后的响应页面。在JSTL标签中引用了”error”变量，这个变量正是LoginController中返回的ModelAndView(“login”,”error”,”用户名或密码错误”)对象所声明的error参数。
login.jsp的登录表单将提交到/loginCheck.html,< c:url value=”loginCheck.html”/>的JSTL标签会在URL前自动加上应用部署根目录。假设应用部署在容器的workbenck目录下，则< c:url>标签将输出/workbenck/loginCheck.html。通过< c:url>标签很好的解决了开发和应用部署目录不一致的问题。

欢迎页面main.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>小春论坛title>
head>
<body>
    ${user.username},欢迎您进入论坛，您当前积分为${user.credits};①
body>
html>

①处访问Session域中的user对象，显示用户名和积分信息。

六、 运行Web应用

Maven工程，运行Web应用有两种方式：第一种是在IDE工具中配置Web应用服务器；第二种是在pom.xml文件中配置Web应用服务器插件。推荐采用第二种。这里我们在pom.xml文件中配置Jetty应用服务器插件。

 <build>
        <plugins>
            
            <plugin>
                <groupId>org.mortbay.jettygroupId>
                <artifactId>maven-jetty-pluginartifactId>
                <version>6.1.25version>
                <configuration>
                    <connectors>
                        <connector implementation="org.mortbay.jetty.nio.SelectChannelConnector">
                            <port>8000port>
                            <maxIdleTime>60000maxIdleTime>
                        connector>
                    connectors>
                    <contextPath>/bbscontextPath>
                    <scanIntervalSeconds>0scanIntervalSeconds>
                configuration>
            plugin>

            <plugin>
                <groupId>org.apache.maven.pluginsgroupId>
                <artifactId>maven-surefire-pluginartifactId>
                <version>2.17version>
                <configuration>
                    <parallel>methodsparallel>
                    <threadCount>10threadCount>
                configuration>
            plugin>
        plugins>
    build>

在pom.xml中配置好Jetty插件之后，在IDEA工程右边的Maven Projects管理窗口工具栏中单击图标，更新依赖包和插件。
双击jetty:run以运行模式启动Jetty服务器。如果想DeBug，右键选择DeBug启动就好。

登录首页

输入错误密码

输入正确密码

至此，一个入门的Spring Web应用就实现了。下篇介绍运用Spring Boot更加快速犀利的搭建Spring Web应用。