1 概述

一个spring完整的入门小案例,做一个登陆功能。

代码 演示:

javaSpring 保持登录状态_数据库

2 实现

2.1 项目环境准备

  1. 创建maven项目
    具体详情可以参考我的另一篇博客:IDEA创建Maven web项目以及Tomcat部署项目的方法 刚开始学习的时候,我比较推荐不使用模板创建项目,自己从0到1搭一个,能更好地熟悉各个模块。
  2. 创建包结构
    在src/mian目录下,先补充webapp和web.xml;
    然后创建src/main/java/com/zou目录,在该目录下分别创建dao、domain、service、web四个包。(这里的zou可以自己起别的名字);
  3. javaSpring 保持登录状态_数据库_02

  4. 导入依赖(实际开发中,应该是在需要的时候再导)
  5. 创建数据库表
DROP DATABASE IF EXISTS sampledb;
CREATE DATABASE sampledb DEFAULT CHARACTER SET utf8;
USE sampledb;

##创建用户表
CREATE TABLE t_user (
   user_id   INT AUTO_INCREMENT PRIMARY KEY,
   user_name VARCHAR(30),
   password  VARCHAR(32),
   credits INT,
   last_visit datetime,
   last_ip  VARCHAR(23)
)ENGINE=InnoDB; 

##创建用户登录日志表
CREATE TABLE t_login_log (
   login_log_id  INT AUTO_INCREMENT PRIMARY KEY,
   user_id   INT,
   ip  VARCHAR(23),
   login_datetime datetime
)ENGINE=InnoDB; 

##插入初始化数据
INSERT INTO t_user (user_name,password) 
             VALUES('admin','123456');
COMMIT;

5.在resources目录下创建zou-context.xml,这个文件主要配置spring的相关信息。具体参考代码。

2.2 Dao层开发

在domain包中创建实体类User和LoginLog,前者表示用户信息,后者表示日志信息,分别对应t_user和t_login_log数据库表。
接下来定义访问User的Dao

@Repository
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_LOGIN_INFO_SQL = " UPDATE t_user SET " +
            " last_visit=?,last_ip=?,credits=?  WHERE user_id =?";

    @Autowired
    public void setJdbcTemplate(JdbcTemplate jdbcTemplate){
        this.jdbcTemplate = jdbcTemplate;
    }

    // 通过userName和password在数据库中查找符合条件的记录数
    public int getMatchCount(String userName, String password){
        return jdbcTemplate.queryForObject(MATCH_COUNT_SQL, new Object[]{userName, password}, Integer.class);
    }

    // 通过userName查找user
    public User findUserByUserName(final String userName){
        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){
        jdbcTemplate.update(UPDATE_LOGIN_INFO_SQL, user.getLastVisit(), user.getLastIp(), user.getCredits(), user.getUserId());
    }
}

定义LoginLogDao,负责记录用户的登录日志

@Repository
public class LoginLogDao {
    private JdbcTemplate jdbcTemplate;

    @Autowired
    public void setJdbcTemplate(JdbcTemplate jdbcTemplate){
        this.jdbcTemplate = jdbcTemplate;
    }

    //保存登陆日志SQL
    private final static String INSERT_LOGIN_LOG_SQL= "INSERT INTO t_login_log(user_id,ip,login_datetime) VALUES(?,?,?)";

    public void insertLoginLog(LoginLog loginLog) {
        Object[] args = { loginLog.getUserId(), loginLog.getIp(),
                loginLog.getLoginDate() };
        jdbcTemplate.update(INSERT_LOGIN_LOG_SQL, args);
    }
}

在Spring中装配Dao,上面的“项目环境准备”中的最后一步创建了一个配置spring的zou-context.xml,在这里配置Dao。

<beans ...>
	<!-- 扫描类包,将标注Spring注解的类自动转化Bean,同时完成Bean的注入 -->
    <context:component-scan base-package="com.zou.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="zhr13392827403" />

    <!-- 配置Jdbc模板  -->
    <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate"
          p:dataSource-ref="dataSource" />
</beans>

到此,dao层已完成。

2.3 Service层开发

在登陆功能中,只有一个service,UserService。负责将Dao层的UserDao和LoginLogDao组织起来,完成用户/密码认证,登陆日志记录等操作。
UserService

@Service
public class UserService {

    private UserDao userDao;
    private LoginLogDao loginLogDao;

    public boolean hasMatchUser(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.setUserId(user.getUserId());
        loginLog.setIp(user.getLastIp());
        loginLog.setLoginDate(user.getLastVisit());
        userDao.updateLoginInfo(user);
        loginLogDao.insertLoginLog(loginLog);
    }

    @Autowired
    public void setUserDao(UserDao userDao) {
        this.userDao = userDao;
    }

    @Autowired
    public void setLoginLogDao(LoginLogDao loginLogDao) {
        this.loginLogDao = loginLogDao;
    }
}

在Spring中装配Service,同样在zou-context.xml中配置。

引入aop和tx命名空间所对应的schema文件

javaSpring 保持登录状态_数据库_03


javaSpring 保持登录状态_bc_04

<!-- 配置事务管理器 -->
    <bean id="transactionManager"
          class="org.springframework.jdbc.datasource.DataSourceTransactionManager"
          p:dataSource-ref="dataSource" />

    <!-- 通过AOP配置提供事务增强,让service包下所有Bean的所有方法拥有事务 -->
    <aop:config proxy-target-class="true">
        <aop:pointcut id="serviceMethod"
                      expression="(execution(* com.zou.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>

单元测试,用TestNG框架测试,在\src\test测试目录下创建与UserService相同的包结构,并创建相应的测试类UserServiceTest。

@ContextConfiguration("classpath*:/zou-context.xml")
public class UserServiceTest extends AbstractTransactionalTestNGSpringContextTests {
    @Autowired
    private UserService userService;

    @Test
    public void testHasMatchUser() {
        boolean b1 = userService.hasMatchUser("admin", "123456");
        boolean b2 = userService.hasMatchUser("admin", "1111");
        assertTrue(b1);
        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);
    }
}

编写完成后,直接在UserServiceTest空白处右键执行。
至此,Service层开发完成。

2.4 Web层开发

对web.xml文件进行配置,以便web容器启动时能自动启动Spring容器

<!--    从类路径加载spring的配置文件zou-context-->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:zou-context.xml</param-value>
    </context-param>

<!--    负责启动spring容器的监听器,它将引用上边配置的spring配置文件地址-->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

配置springMVC的servlet和url映射

<servlet>
        <servlet-name>zou</servlet-name>
        <servlet-class>
            org.springframework.web.servlet.DispatcherServlet
        </servlet-class>
        <load-on-startup>3</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>zou</servlet-name>
        <url-pattern>*.html</url-pattern>
    </servlet-mapping>

处理登陆请求,编写pojo控制类,LoginController,本质是一个servlet

@Controller
public class LoginController {
    private UserService userService;

    @RequestMapping(value = "/index.html")
    public String loginPage(){
        return "login";
    }

    @RequestMapping(value = "/loginCheck.html")
    public ModelAndView loginCheck(HttpServletRequest request, LoginCommand loginCommand){
        boolean isValidUser = userService.hasMatchUser(loginCommand.getUserName(), loginCommand.getPassword());
//        boolean isValidUser = userService.hasMatchUser(loginCommand.getUserName(), "123456");
        System.out.println("username=" + loginCommand.getUserName()+" password=" + loginCommand.getPassword()+" isValidUser="+isValidUser);
        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");
        }
    }

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

还有一个LoginCommand处理用户和密码两个属性

public class LoginCommand {
    private String userName;
    private String password;

    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;
    }
}

编写完Controller后,需要在spring中配置该控制器,但是不是在zou-context.xml中配置,而是在/webapp/WEB-INF中新建一个zou-servlet.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: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">
    <!-- 扫描web包,应用Spring的注解 -->
    <context:component-scan base-package="com.zou.web"/>

    <!-- 配置视图解析器,将ModelAndView及字符串解析为具体的页面 -->
    <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>

通过LoginController的ModelAndView,将处理结果解析到具体页面
JSP页面,login.jsp和main.jsp,在/webapp/WEB-INF目录下新建一个jsp目录,然后将两个jsp页面放在该目录下
login.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ 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="<c:url value="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>

main.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<html>
<head>
    <title>春天论坛</title>
</head>
<body>
    ${user.userName},欢迎您进入小春论坛,您当前积分为${user.credits};
</body>
</html>

2.5 启动web应用

通过jetty插件运行web应用。
在pom.xml中添加jetty插件

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

contextPath,用于配置web应用上下文。

在idea的右侧maven使用插件

javaSpring 保持登录状态_bc_05


javaSpring 保持登录状态_javaSpring 保持登录状态_06


在浏览器中输入localhost:8000/demo/index.html访问,这里的demo就是前边设置的contextPath。

至此,登陆功能完成。

演示:

javaSpring 保持登录状态_bc_07

3 bug

记录一下遇到的bug及解决方法
Bug
1.spring配置文件提示:application context not configured for this file
在structure中添加spring配置到项目中
2.Could not autowire. No beans of ‘UserDao’ type found.
在dao类上添加@Repository
3.Cannot create PoolableConnectionFactory (Could not create connection to database server.)
sql语句写错,多写了一个参数占位符,但是没有给这个参数传参数。
4.com.mysql.cj.jdbc.Driver和com.mysql.jdbc.Driver
com.mysql.jdbc.Driver是mysql-connector-java 5中的。如果mysql-connector-java用的6.0以上的,此时需要把com.mysql.jdbc.Driver改为com.mysql.cj.jdbc.Driver。

4 实现流程总结

项目环境准备

创建maven项目
创建包结构
导入依赖
创建数据库表
创建spring配置文件

Dao层开发

创建实体类User和LoginLog
创建UserDao和LoginLogDao
spring装配Dao

Service开发

创建UserService
spring装配Service
单元测试

Web层开发

web.xml配置spring容器
配置springMVC的servlet和url映射
创建LoginController
创建LoginCommand
spring装配servlet
前端页面login.jsp和main.jsp

启动web应用