版权声明
- 本文原创作者:谷哥的小弟
- 作者博客地址:http://blog.csdn.net/lfdfhl
教程概述
本教程以图文形式详细讲解SpringBoot整合SSM框架的流程以及具体步骤及其注意事项。
此为演示案例,请在实际项目开发过程中将相关信息替换为与实际情况吻合的代码。
数据准备
在此,准备本教程所需的数据库、数据表及其数据;详情如下:
DROP DATABASE IF EXISTS crmsb;
-- 创建数据库crmsb
CREATE DATABASE crmsb;
-- 选择数据库crmsb
USE crmsb;
-- 创建用户表user
CREATE TABLE user(
id INT primary key auto_increment,
username VARCHAR(50),
password VARCHAR(50),
gender VARCHAR(10)
);
-- 向用户表user中插入数据
INSERT INTO user(username,password,gender) VALUES("zxc","123456","female");
INSERT INTO user(username,password,gender) VALUES("zxx","123456","female");
INSERT INTO user(username,password,gender) VALUES("wmd","123456","female");
-- 查询用户表user中的数据
SELECT * FROM user;
数据库操作结果如下图所示:
创建SpringBoot项目
在此,详细介绍在IDEA使用Spring Initializr构建SpringBoot项目的过程及其主要步骤。
新建项目,图示如下:
利用Spring Initializr创建Spring Boot项目CRMSB。请注意:SpringBoot3要求JDK不低于17版本。图示如下:
然后点击Next,进入下一步;图示如下:
要点概述:
- 1、勾选Web下的Spring Web添加依赖。其实,在此步骤还可以勾选其它依赖。假若此处不勾选则需后续在pom.xml文件中添加依赖。
- 2、Spring Boot 3.3.0表示当前最新的稳定版本
点击Finish后创建SpringBoot项目,图示如下:
请点击Settings配置Maven;图示如下:
请依据实际情况配置Maven;图示如下:
点击OK后请刷新Maven;图示如下:
启动项目,检查项目是否可正常启动;图示如下:
整合SSM框架
在之前的操作中,我们完成了在IDEA中创建了基本的SpringBoot项目。接下来,我们在此基础上整合SSM三大框架。
添加依赖
在项目初始化之后pom.xml文件中自带部分依赖,图示如下:
在此,我们需要将SSM项目中常用的依赖添加至< dependencies ></ dependencies >中。常见的有:MySQL、druid、pagehelper、MyBatis、jackson、jstl等等;详情如下:
<dependencies>
<!--web依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--test依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--MySQL依赖-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.38</version>
</dependency>
<!--druid依赖-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
<!--MyBatis依赖-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
<!--分页依赖-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.4.1</version>
</dependency>
<!--jsp解析依赖-->
<dependency>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-jasper</artifactId>
</dependency>
<!--jstl依赖-->
<dependency>
<groupId>jstl</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!--热部署依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
<!--jackson依赖-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.16.2</version>
</dependency>
</dependencies>
添加以上依赖后,请再次刷新Maven。
创建包
在此,提前准备好项目中可能用到的包。
创建与Java代码相关的包
首先,请在java包下的com.cn.crmsb中创建与Java代码相关的包;常见的有:config、controller、pojo、service、mapper、interceptor、utils等;图示如下:
注意事项:
SpringBoot项目的启动类CrmsbApplication与java各包是并行的关系。请勿将CrmsbApplication置于任意包中。
创建与resources代码相关的包
请在resources下以com/cn/crmsb/mapper的方式创建com.cn.crmsb.mapper包用于存放mapper的映射文件。
注意事项:
- 1、请勿以com.cn.crmsb.mapper的方式创建mapper包
- 2、mapper映射文件的包名需与mapper的接口文件所在包的包名保持一致
图示如下:
创建与webapp相关的文件夹
请在main包下创建与页面资源相关的文件夹webapp,并将项目所需的静态资源(Bootstrap、css、fonts、imgs、js等)以及jsp页面拷贝至webapp中;图示如下:
编写配置文件
在此,完善项目配置文件application.properties的编写。
要点概述:
- 1、请务必注意配置文件中的包名,请依据项目实际情况设置
- 2、请务必注意配置文件中的路径,请依据项目实际情况设置
- 3、请务必注意配置文件中的配置信息,请依据项目实际情况设置
- 4、请务必注意截图的红色标记,请依据项目实际情况设置
application.properties源码如下:
# 配置端口
server.port=9090
# 配置项目名
server.servlet.context-path=/
# 开启jsp模板开发模式
server.servlet.jsp.init-parameters.development=true
# 指定视图前缀(目录名)
spring.mvc.view.prefix=/views/
# 指定视图后缀
spring.mvc.view.suffix=.jsp
# 配置MySQL数据库以及数据源
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/crmsb?characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
# 指定项目静态资源的路径
spring.web.resources.static-locations= classpath:/
# 指定mapper映射文件存放位置
mybatis.mapper-locations=classpath:com/cn/crmsb/mapper/*.xml
# 配置MyBatis别名所作用的包
mybatis.type-aliases-package=com.cn.crmsb.pojo
# 配置日志
logging.level.root=info
logging.level.com.cn.crmsb=debug
# 配置分页
pagehelper.helper-dialect=mysql
pagehelper.reasonable=true
pagehelper.support-methods-arguments=true
pagehelper.params=count=countSql
# 配置文件上传
spring.servlet.multipart.max-file-size=5MB
spring.servlet.multipart.max-request-size=50MB
需要依据实际情况进行配置的信息如下:
编写各层代码
接下来,我们按照分层思想以用户登录为例完成代码的编写工作。
User类
请在pojo包下创建User类。
User类作为JavaBean,其属性名应尽量与数据库中user表的字段保持一致。
package com.cn.crmsb.pojo;
/**
* 本文作者:谷哥的小弟
* 博客地址:http://blog.csdn.net/lfdfhl
*/
public class User {
private Integer id;
private String username;
private String password;
private String gender;
public User() {
}
public User(Integer id, String username, String password, String gender) {
this.id = id;
this.username = username;
this.password = password;
this.gender = gender;
}
public Integer getId() {
return id;
}
public void setId(Integer 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 getGender() {
return gender;
}
public void setGender(String gender) {
this.gender = gender;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", password=" + password + ", gender=" + gender + "]";
}
}
UserMapper接口文件
请在mapper包下创建UserMapper接口文件UserMapper.java。
要点概述:
- 1、在该接口中定义方法queryUserByUsernameAndPassword( )
- 2、在UserMapper接口上使用@Repository注解
package com.cn.crmsb.mapper;
import com.cn.crmsb.pojo.User;
import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Repository;
import java.util.List;
/**
* 本文作者:谷哥的小弟
* 博客地址:http://blog.csdn.net/lfdfhl
*/
@Repository
public interface UserMapper {
//利用@Param注解向MyBatis传递参数
User queryUserByUsernameAndPassword(@Param("username") String u, @Param("password") String p);
}
UserMapper映射文件
请在resources中的com.cn.crmsb.mapper包下创建UserMapper映射文件UserMapper.xml。
要点概述:
- 1、映射文件名与映射接口名保持一致,均为UserMapper;但是,后缀不同
- 2、映射文件中的namespace属性值为接口文件UserMapper.java的全路径名
- 3、select标签的id属性值为接口文件UserMapper.java中的方法名queryUserByUsernameAndPassword
- 4、select标签的parameterType属性值为queryUserByUsernameAndPassword方法的输入参数类型
- 5、select标签的resultType属性值为queryUserByUsernameAndPassword方法的返回值类型;但是,其首字母小写。
- 6、select标签中使用占位符编写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.cn.crmsb.mapper.UserMapper">
<!-- 查询用户 -->
<select id="queryUserByUsernameAndPassword" parameterType="String" resultType="user">
select * from user where username = #{username} and password = #{password}
</select>
</mapper>
UserService
请在service包下创建UserService接口。
请在service包下创建impl子包并在impl包下创建UserService接口的实现类UserServiceImpl。
要点概述:
- 1、在UserService接口中声明queryUserByUsernameAndPassword()方法
- 2、在UserServiceImpl类上使用@Service注解
- 3、在UserServiceImpl类上使用@Transactional注解
- 4、在UserServiceImpl类中使用@Autowired注入UserMapper
- 5、在UserServiceImpl类的queryUserByUsernameAndPassword()方法中调用UserMapper的queryUserByUsernameAndPassword()方法
UserService接口如下:
package com.cn.crmsb.service;
import com.cn.crmsb.pojo.User;
import java.util.List;
/**
* 本文作者:谷哥的小弟
* 博客地址:http://blog.csdn.net/lfdfhl
*/
public interface UserService {
//查询用户
User queryUserByUsernameAndPassword(String username, String password);
}
UserServiceImpl类如下:
package com.cn.crmsb.service.impl;
import com.cn.crmsb.mapper.UserMapper;
import com.cn.crmsb.pojo.User;
import com.cn.crmsb.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.util.List;
/**
* 本文作者:谷哥的小弟
* 博客地址:http://blog.csdn.net/lfdfhl
*/
@Service("userService")
@Transactional
public class UserServiceImpl implements UserService {
@Autowired
private UserMapper userMapper;
//查询用户
@Override
public User queryUserByUsernameAndPassword(String username, String password) {
User user = userMapper.queryUserByUsernameAndPassword(username, password);
return user;
}
}
UserController
请在controller包下创建UserController。
要点概述:
- 1、在UserController类上使用@Controller注解和@RequestMapping注解
- 2、在UserController类中使用@Autowired注入UserService
- 3、在UserController类中定义login()方法
- 4、在login()方法上使用@RequestMapping注解
- 5、在login()方法中调用UserService的queryUserByUsernameAndPassword()方法
- 6、登录成功后将用户信息保存至session
- 7、login()方法的返回值为跳转页面的路径
- 8、登录成功后跳转至ok页面
- 9、登录失败后跳转至login页面
package com.cn.crmsb.controller;
import com.cn.crmsb.pojo.User;
import com.cn.crmsb.service.UserService;
import jakarta.servlet.http.HttpSession;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
/**
* 本文作者:谷哥的小弟
* 博客地址:http://blog.csdn.net/lfdfhl
*/
@RequestMapping("userController")
@Controller
public class UserController {
@Autowired
private UserService userService;
//登录
@RequestMapping(value = "login", method = RequestMethod.POST)
public String login(String username, String password, Model model, HttpSession session) {
User user = userService.queryUserByUsernameAndPassword(username, password);
System.out.println("user="+user);
if (user != null) {
// 保存当前用户USER至Session
session.setAttribute("USER", user);
// 重定向至客户列表页面
// return "redirect:/customerController/list";
// 重定向至登录成功页面loginSuc
return "ok";
}
model.addAttribute("msg", "账号或密码错误,请您重新输入!");
// 返回至登录页面
return "login";
}
}
login页面
webapp包下views中的login.jsp页面如下:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<!DOCTYPE HTML>
<html>
<head>
<title>CRM 用户登录</title>
<meta http-equiv=Content-Type content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- ${pageContext.request.contextPath} 表示 /CRM -->
<!-- 引入Bootstrap -->
<link rel="stylesheet" href="../Bootstrap/css/bootstrap.min.css"/>
<!-- 引入jQuery -->
<script src="../js/jquery-1.11.3.min.js"></script>
<!-- 引入Bootstrap的JavaScript插件 -->
<script src="../Bootstrap/js/bootstrap.min.js"></script>
<link href="../css/sb-admin-2.css" rel="stylesheet"/>
<link href="../css/font-awesome.min.css" rel="stylesheet"/>
<script src="../js/sb-admin-2.js"></script>
<script>
// 校验用户和密码是否为空
function checkLogin() {
var username = $("#inputUsername").val();
var password = $("#inputPassword").val();
if (username == "" || password == "") {
$("#message").text("用户和密码不能为空!");
return false;
}
return true;
}
</script>
</head>
<body>
<div class="container" style="width: 40%">
<form class="form-signin" action="${pageContext.request.contextPath}/userController/login" method="post"
onsubmit="return checkLogin()">
<h2 class="form-signin-heading text-center">CRM</h2>
<br>
<!-- 提示信息 -->
<p><span id="message" style="color: red">${msg}</span></p>
<label for="inputUsername" class="sr-only">用户名</label>
<input type="text" id="inputUsername" name="username" class="form-control" placeholder="请输入用户名"
autofocus>
<p></p>
<label for="inputPassword" class="sr-only">密码</label>
<input type="password" id="inputPassword" name="password" class="form-control" placeholder="请输入密码">
<br>
<button class="btn btn-lg btn-primary btn-block" type="submit">登陆</button>
<a class="btn btn-link btn-block" href="#">注册</a>
</form>
</div>
</body>
</html>
ok页面
webapp包下views中的ok.jsp页面如下:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<!DOCTYPE HTML>
<html>
<head>
<title>OK</title>
</head>
<body>
<h1>Login OK</h1>
</body>
</html>
配置SpringBoot项目启动类
在完成各层代码编写之后,我们再来配置SpringBoot项目的启动类CrmsbApplication。
请在CrmsbApplication类上使用@MapperScan注解扫描mapper接口文件。
package com.cn.crmsb;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* 本文作者:谷哥的小弟
* 博客地址:http://blog.csdn.net/lfdfhl
*/
@SpringBootApplication
@MapperScan("com.cn.crmsb.mapper")
public class CrmsbApplication {
public static void main(String[] args) {
SpringApplication.run(CrmsbApplication.class, args);
}
}
部署与测试
请在CrmsbApplication 类中点击绿色按钮运行项目,图示如下:
项目启动完毕后,请在浏览器中输入 http://localhost:9090/views/login.jsp 进行登录。
测试信息:
- 1、用户名zxc
- 2、密码123456
登录成功后跳转至ok.jsp;图示如下:
总结
总体而言,在IDEA中利用SpringBoot整合SSM框架的技术难度不大;但是需要注意的细节之处较多。所以,在整合过程中务必细致周到,考虑周全,富有耐心。
另外,请开发人员注意:SpringBoot的版本可能与jar包的版本存在兼容性问题。常见的Jar包请在Maven仓库中查询,官方地址为:https://mvnrepository.com/