Spring Boot+CAS 单点登陆，如何对接数据库？

时间 2020-07-09

标签 spring boot+cas boot cas 单点登陆如何对接数据库栏目 Spring 繁體版

原文原文链接

在前面的两篇文章中，松哥和你们分享了 CAS Server 的搭建以及如何使用 Spring Security 搭建 CAS Client。java

可是前面的案例有一个问题，就是登陆用户是在 CAS Server 配置文件中写死的，没有对接数据库，实际项目中，这里确定要对接数据库，因此今天，松哥就来和你们聊一聊 CAS Server 如何对接数据库。mysql

松哥最近和 Spring Security 杠上了，这是 Spring Security 系列的第 25 篇：git

1.总体思路

先来看总体思路。github

咱们用 CAS Server 作单点登陆，CAS Server 主要是负责认证的，也就是它主要解决登陆问题。登陆成功以后，还有一个权限处理的问题，权限的问题则交由各个 CAS Client 自行处理，并不在 CAS Server 中完成。spring

在上篇文章中，松哥有教过你们定义 UserDetailsService，不知道你们是否还记得以下代码（忘记了能够参考上篇文章：Spring Boot 实现单点登陆的第三种方案！）：sql

@Component
@Primary
public class UserDetailsServiceImpl implements UserDetailsService{

    @Override
    public UserDetails loadUserByUsername(String s) throws UsernameNotFoundException {
        return new User(s, "123", true, true, true, true,
                AuthorityUtils.createAuthorityList("ROLE_user"));
    }
}

这段代码是在何时执行呢？数据库

若是咱们没有使用 CAS 这一套的话，这段代码固然是在用户登陆的时候执行，用户登陆时，从数据库中查询用户的信息，而后作校验（参考本系列前面文章就懂）。后端

若是咱们使用 CAS 这一套，用户登陆的校验将在 CAS Server 上执行，CAS Client 就不用作校验工做了，可是为何咱们还须要定义 UserDetailsService 呢？这是为了当用户在 CAS Server 上登陆成功以后，拿着用户名回到 CAS Client，而后咱们再去数据库中根据用户名获取用户的详细信息，包括用户的角色等，进而在后面的鉴权中用上角色。浏览器

好了，这是咱们一个大体的思路，接下来咱们来看具体实现。安全

2.具体实现

接下来的配置在松哥手把手教你入门 Spring Boot + CAS 单点登陆一文的基础上完成，因此还没看前面文章的小伙伴建议先看一下哦。

2.1 准备工做

首先咱们先在数据库中准备一下用户表、角色表以及用户角色关联表：

CREATE TABLE `t_role` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `name_zh` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

CREATE TABLE `t_user` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `account_non_expired` bit(1) NOT NULL,
  `account_non_locked` bit(1) NOT NULL,
  `credentials_non_expired` bit(1) NOT NULL,
  `enabled` bit(1) NOT NULL,
  `password` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `username` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

CREATE TABLE `t_user_roles` (
  `t_user_id` bigint(20) NOT NULL,
  `roles_id` bigint(20) NOT NULL,
  KEY `FKj47yp3hhtsoajht9793tbdrp4` (`roles_id`),
  KEY `FK7l00c7jb4804xlpmk1k26texy` (`t_user_id`),
  CONSTRAINT `FK7l00c7jb4804xlpmk1k26texy` FOREIGN KEY (`t_user_id`) REFERENCES `t_user` (`id`),
  CONSTRAINT `FKj47yp3hhtsoajht9793tbdrp4` FOREIGN KEY (`roles_id`) REFERENCES `t_role` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

INSERT INTO `t_role` (`id`, `name`, `name_zh`) VALUES (1,'ROLE_admin','管理员'),(2,'ROLE_user','普通用户');
INSERT INTO `t_user` (`id`, `account_non_expired`, `account_non_locked`, `credentials_non_expired`, `enabled`, `password`, `username`) VALUES (1,b'1',b'1',b'1',b'1','123','javaboy'),(2,b'1',b'1',b'1',b'1','123','江南一点雨');
INSERT INTO `t_user_roles` (`t_user_id`, `roles_id`) VALUES (1,1),(2,2);

2.2 CAS Server

而后咱们要在 CAS Server 的 pom.xml 文件中添加两个依赖：

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-jdbc-drivers</artifactId>
    <version>${cas.version}</version>
</dependency>
<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-jdbc</artifactId>
    <version>${cas.version}</version>
</dependency>

注意这里不用添加数据库驱动，系统会自动解决。

添加完成以后，再在 src/main/resources/application.properties 文件中添加以下配置：

cas.authn.jdbc.query[0].url=jdbc:mysql://127.0.0.1:3306/withjpa?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&useSSL=false
cas.authn.jdbc.query[0].user=root
cas.authn.jdbc.query[0].password=123
cas.authn.jdbc.query[0].sql=select * from t_user where username=?
cas.authn.jdbc.query[0].fieldPassword=password
cas.authn.jdbc.query[0].driverClass=com.mysql.cj.jdbc.Driver

前三行配置是数据库基本链接配置，这个无需我多说。
第四行表示配置用户查询 sql，根据用户名查询出用户的全部信息。
第五行表示数据库中密码的字段名字是什么。
第六行是数据库驱动。

OK，配置完成后，接下来咱们就来重启 CAS Server：

./build.sh run

启动成功后，浏览器输入 https://cas.javaboy.org:8443/cas/login 就能够进入登陆页面了（注意是 https 哦）：

此时登陆用户名就是 javaboy，密码是 123。

2.3 CAS Client

接下来咱们再来看看 CAS Client 要作哪些完善。

接下来的配置在 Spring Boot 实现单点登陆的第三种方案！一文的基础上完成，因此还没看前面文章的小伙伴建议先看一下哦。

同时，为了案例简洁，我这里使用 JPA 来操做数据库，要是你们不熟悉这块的操做，能够参考本系列以前的文章：Spring Security+Spring Data Jpa 强强联手，安全管理只有更简单！。

CAS Client 中的对接主要是实现 UserDetailsService 接口。这里要用到数据库查询，因此咱们首先添加数据库相关依赖：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

而后在 application.properties 中配置数据库链接信息：

spring.datasource.username=root
spring.datasource.password=123
spring.datasource.url=jdbc:mysql:///withjpa?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai

spring.jpa.database=mysql
spring.jpa.database-platform=mysql
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL8Dialect

都是常规配置，咱们就再也不重复解释了。

接下来咱们建立两个实体类，分别表示用户角色了用户类：

用户角色：

@Entity(name = "t_role")
public class Role {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String nameZh;
    //省略 getter/setter
}

这个实体类用来描述用户角色信息，有角色 id、角色名称（英文、中文），@Entity 表示这是一个实体类，项目启动后，将会根据实体类的属性在数据库中自动建立一个角色表。

用户实体类：

@Entity(name = "t_user")
public class User implements UserDetails {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String username;
    private String password;
    private boolean accountNonExpired;
    private boolean accountNonLocked;
    private boolean credentialsNonExpired;
    private boolean enabled;
    @ManyToMany(fetch = FetchType.EAGER,cascade = CascadeType.PERSIST)
    private List<Role> roles;
    @Override
    public Collection<? extends GrantedAuthority> getAuthorities() {
        List<SimpleGrantedAuthority> authorities = new ArrayList<>();
        for (Role role : getRoles()) {
            authorities.add(new SimpleGrantedAuthority(role.getName()));
        }
        return authorities;
    }
    @Override
    public String getPassword() {
        return password;
    }

    @Override
    public String getUsername() {
        return username;
    }

    @Override
    public boolean isAccountNonExpired() {
        return accountNonExpired;
    }

    @Override
    public boolean isAccountNonLocked() {
        return accountNonLocked;
    }

    @Override
    public boolean isCredentialsNonExpired() {
        return credentialsNonExpired;
    }

    @Override
    public boolean isEnabled() {
        return enabled;
    }
    //省略其余 get/set 方法
}

用户实体类主要须要实现 UserDetails 接口，并实现接口中的方法。

这里的字段基本都好理解，几个特殊的我来稍微说一下：

accountNonExpired、accountNonLocked、credentialsNonExpired、enabled 这四个属性分别用来描述用户的状态，表示帐户是否没有过时、帐户是否没有被锁定、密码是否没有过时、以及帐户是否可用。
roles 属性表示用户的角色，User 和 Role 是多对多关系，用一个 @ManyToMany 注解来描述。
getAuthorities 方法返回用户的角色信息，咱们在这个方法中把本身的 Role 稍微转化一下便可。

数据模型准备好以后，咱们再来定义一个 UserDao：

public interface UserDao extends JpaRepository<User,Long> {
    User findUserByUsername(String username);
}

这里的东西很简单，咱们只须要继承 JpaRepository 而后提供一个根据 username 查询 user 的方法便可。若是小伙伴们不熟悉 Spring Data Jpa 的操做，能够在公众号后台回复 springboot 获取松哥手敲的 Spring Boot 教程，里边有 jpa 相关操做，也能够看看松哥录制的视频教程：Spring Boot + Vue 系列视频教程。

在接下来定义 UserService ，以下：

@Component
@Primary
public class UserDetailsServiceImpl implements UserDetailsService{

    @Autowired
    UserDao userDao;
    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        User user = userDao.findUserByUsername(username);
        if (user == null) {
            throw new UsernameNotFoundException("用户不存在");
        }
        return user;
    }
}

咱们本身定义的 UserDetailsServiceImpl 须要实现 UserDetailsService 接口，实现该接口，就要实现接口中的方法，也就是 loadUserByUsername。

OK ，如此以后，咱们的 CAS Client 如今就开发完成了，接下来启动 CAS Client，启动成功后，浏览器输入 http://client1.cas.javaboy.org:8080/user/hello 访问 hello 接口，此时会自动跳转到 CAS Server 上登陆，登陆的用户名密码就是咱们存储在数据库中的用户名密码。登陆成功以后，通过两个重定向，会从新回到 hello 接口。

hello 接口访问成功以后，再去访问 /user/hello 接口，就会发现权限配置也生效了。

这里比较简单，我就不给你们截图了。

3.小结

好啦，今天主要和小伙伴们分享了一下 Spring Security + CAS 单点登陆中，如何使用本地数据库。一个核心的思路是，认证由 CAS Server 来作，权限相关的操做，则仍是由 Spring Security 来完成。

好了，本文就说到这里，本文相关案例我已经上传到 GitHub ，你们能够自行下载:https://github.com/lenve/spring-security-samples

好啦，小伙伴们若是以为有收获，记得点个在看鼓励下松哥哦～