环境:SpringBoot 2.1 + Mybatis + Spring Security 5.0
一、导入依赖
导入 spring-boot-starter-security 依赖,在 SpringBoot 2.1 环境下默认使用的是 5.0 版本。
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.jelly</groupId>
<artifactId>spring-boot-security</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-boot-security</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.2.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.6</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
二、创建数据库
一般权限控制有三层,即:用户<–>角色<–>权限,用户与角色是多对多,角色和权限也是多对多。这里我们先暂时不考虑权限,只考虑用户<–>角色。
创建用户表sys_user:
CREATE TABLE `sys_user` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(255) NOT NULL,
`password` varchar(255) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
创建权限表sys_role:
CREATE TABLE `sys_role` (
`id` int(11) NOT NULL,
`name` varchar(255) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
创建用户-角色表sys_user_role:
CREATE TABLE `sys_user_role` (
`user_id` int(11) NOT NULL,
`role_id` int(11) NOT NULL,
PRIMARY KEY (`user_id`,`role_id`),
KEY `fk_role_id` (`role_id`),
CONSTRAINT `fk_role_id` FOREIGN KEY (`role_id`) REFERENCES `sys_role` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
CONSTRAINT `fk_user_id` FOREIGN KEY (`user_id`) REFERENCES `sys_user` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
初始化一下数据:
INSERT INTO `sys_role` VALUES ('1', 'ROLE_ADMIN');
INSERT INTO `sys_role` VALUES ('2', 'ROLE_USER');
INSERT INTO `sys_user` VALUES ('1', 'admin', '123');
INSERT INTO `sys_user` VALUES ('2', 'jelly', '123');
INSERT INTO `sys_user_role` VALUES ('1', '1');
INSERT INTO `sys_user_role` VALUES ('2', '2');
注意:这里的权限格式为ROLE_XXX,是Spring Security规定的,不要乱起名字哦。
三、准备页面
因为是示例程序,页面越简单越好,只用于登陆的login.html以及用于登陆成功后的home.html,将其放置在 resources/static 目录下:
(1)login.html:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>登陆</title>
</head>
<body>
<h1>登陆</h1>
<form method="post" action="/login">
<div>
用户名:<input type="text" name="username">
</div>
<div>
密码:<input type="password" name="password">
</div>
<div>
<button type="submit">立即登陆</button>
</div>
</form>
</body>
</html>
注意:
用户的登陆认证是由Spring Security进行处理的,请求路径默认为/login,用户名字段默认为username,密码字段默认为password
2)home.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>登陆成功</h1>
<a href="/admin">检测ROLE_ADMIN角色</a><br>
<a href="/user">检测ROLE_USER角色</a>
<button onclick="window.location.href='/logout'">退出登录</button>
</body>
</html>
四、配置application.properties
在配置文件中配置下数据库连接:
# 数据源
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/study?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8&useSSL=true
spring.datasource.username=root
spring.datasource.password=123456
#开启Mybatis下划线命名转驼峰命名
mybatis.configuration.map-underscore-to-camel-case=true
五、创建实体、Dao、Service和Controller
5.1 实体
(1)SysUser
package com.jelly.security.bean;
import lombok.Data;
import java.io.Serializable;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 18:53
**/
@Data
public class SysUser {
private Integer id;
private String name;
private String password;
}
(2)SysRole
package com.jelly.security.bean;
import lombok.Data;
import java.io.Serializable;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 18:54
**/
@Data
public class SysRole {
private Integer id;
private String name;
}
(3)SysUserRole
package com.jelly.security.bean;
import lombok.Data;
import java.io.Serializable;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 18:55
**/
@Data
public class SysUserRole {
private Integer userId;
private Integer roleId;
}
5.2 Dao
(1)SysUserMapper
package com.jelly.security.dao;
import com.jelly.security.bean.SysUser;
import org.apache.ibatis.annotations.Select;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 19:03
**/
public interface SysUserMapper {
@Select("SELECT * FROM sys_user WHERE id = #{id}")
SysUser getById(Integer id);
@Select("SELECT * FROM sys_user WHERE name = #{name}")
SysUser getByName(String name);
}
(2)SysRoleMapper
package com.jelly.security.dao;
import com.jelly.security.bean.SysRole;
import org.apache.ibatis.annotations.Select;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 19:07
**/
public interface SysRoleMapper {
@Select("SELECT * FROM sys_role WHERE id = #{id}")
SysRole getById(Integer id);
}
(3)SysUserRoleMapper
package com.jelly.security.dao;
import com.jelly.security.bean.SysUserRole;
import org.apache.ibatis.annotations.Select;
import java.util.List;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 19:08
**/
public interface SysUserRoleMapper {
@Select("SELECT * FROM sys_user_role WHERE user_id = #{userId}")
List<SysUserRole> listByUserId(Integer userId);
}
5.3 Service
(1)SysUserService
package com.jelly.security.service;
import com.jelly.security.bean.SysUser;
import com.jelly.security.dao.SysUserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 19:09
**/
@Service
public class SysUserService {
@Autowired
private SysUserMapper userMapper;
public SysUser getById(Integer id) {
return userMapper.getById(id);
}
public SysUser getByName(String name) {
return userMapper.getByName(name);
}
}
(2)SysRoleService
package com.jelly.security.service;
import com.jelly.security.bean.SysRole;
import com.jelly.security.dao.SysRoleMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 19:10
**/
@Service
public class SysRoleService {
@Autowired
private SysRoleMapper roleMapper;
public SysRole getById(Integer id){
return roleMapper.getById(id);
}
}
(3)SysUserRoleService
package com.jelly.security.service;
import com.jelly.security.bean.SysUserRole;
import com.jelly.security.dao.SysUserRoleMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 19:11
**/
@Service
public class SysUserRoleService {
@Autowired
private SysUserRoleMapper userRoleMapper;
public List<SysUserRole> listByUserId(Integer userId) {
return userRoleMapper.listByUserId(userId);
}
}
5.4 Controller
LoginController
package com.jelly.security.web;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* @version V1.0
* @author: Jelly
* @program: spring-boot-security
* @description:
* @date: 2019-03-10 19:12
**/
@Controller
public class LoginController {
private Logger logger = LoggerFactory.getLogger(LoginController.class);
@RequestMapping("/")
public String showHome() {
String name = SecurityContextHolder.getContext().getAuthentication().getName();
logger.info("当前登陆用户:" + name);
return "home.html";
}
@RequestMapping("/login")
public String showLogin() {
return "login.html";
}
@RequestMapping("/admin")
@ResponseBody
@PreAuthorize("hasRole('ROLE_ADMIN')")
public String printAdmin() {
return "如果你看见这句话,说明你有ROLE_ADMIN角色";
}
@RequestMapping("/user")
@ResponseBody
@PreAuthorize("hasRole('ROLE_USER')")
public String printUser() {
return "如果你看见这句话,说明你有ROLE_USER角色";
}
}
六、启动类上添加注解
SpringBootSecurityApplication
package com.jelly.security;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.jelly.security.dao")
public class SpringBootSecurityApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootSecurityApplication.class, args);
}
}
七、运行
访问:http://localhost:8080/home.html 会自动跳转登录页面,
管理员用户:
用户名:admin
密码:123
普通用户:
用户名:jelly
密码:123
登录成功后,可以进入home.html页面,进行检测是否为管理员权限。
Spring Security 最基本的 用户-权限-资源 访问 就实现啦,剩下的就需要你的小脑瓜来创新啦。