最详细的Keycloak教程(建议收藏):Keycloak实现手机号、验证码登陆——(二)Keycloak与SpringBoot的集成

本文主要是介绍最详细的Keycloak教程(建议收藏):Keycloak实现手机号、验证码登陆——(二)Keycloak与SpringBoot的集成,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

上一篇已经介绍了keycloak的下载与使用: Keycloak的下载与使用
本文章和大家分享keycloak怎么去集成springboot项目,以及怎么去做接口权限的校验。

PS:根据红帽的公告,目前在springboot 3.x版本已经不支持keycloak适配器,所以本章基于springboot 2.7.16版本,集成keycloak做登录校验,并且本项目不是前后端分离的,前后端分离后面也会讲到。keycloak公告

一、在keycloak创建客户端(client)

1.新建一个域,名称叫做springboot,步骤如下:
add 域
add
点击创建即可:
index
2.新建一个客户端
add client
填写客户端ID,协议就使用默认的openID就可以了

在这里插入图片描述
创建好之后,客户端协议选择 confidential
客户端配置
这里给大家解释一下访问类型

public: 适用于客户端应用,如前端web系统,包括采用vue、react实现的前端项目等。不需要秘钥访问。
confidential: 适用于服务端应用,比如需要浏览器登录以及需要通过密钥获取access token的web系统。需要秘钥访问。
bearer-only: 适用于服务端应用,只允许使用bearer token请接口,项目里的权限是针对接口做校验,请求没有带上token就会返回401。需要秘钥访问。

凭据秘钥后面会用到:
在这里插入图片描述

下面的有效重定向填写自己后端的路径就行了,记得加上/*
在这里插入图片描述
完成之后点击最下面的保存即可。

接下来为realm分别创建两个角色 user 和admin
点击菜单栏的角色按钮
角色
添加角色
add role
role-user
回到角色页面,我们把默认的角色设置为user
默认
完成之后我们到用户页面添加一个用户 user001。
add-user
save-user
这里可以根据自己的业务需求填写其他信息。
保存完成之后我们点击上面的凭据,为用户设置密码,这里我们可以选择此次设置的密码是否为临时密码。我这里吧临时密码关掉了。
password
在这里插入图片描述

添加成功之后,让我们查看一下该用户的权限,可以看到该用户已经设置了user权限(前面的默认权限操作,设置了user为域的默认权限,也可以不设置默认权限)。
role
到这里,keycloak的设置就暂时结束了。

二、创建springboot项目并且集成keycloak

好了,现在我们去创建一个springboot项目(怎么创建我就不说了),网上很多教程的。
创建好了之后,创建HomeController,在里面写几个简单的方法。

导入maven:pom代码送上,直接copy

 <!-- keycloak -->
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.16</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.sky</groupId><artifactId>keycloak-demo</artifactId><version>0.0.1-SNAPSHOT</version><name>keycloak-demo</name><description>keycloak-demo</description><properties><java.version>17</java.version><keycloak.version>19.0.3</keycloak.version><hutool.version>5.8.21</hutool.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>${hutool.version}</version></dependency><!-- 管理员客户端API   注册和创建client、realm需要用到的 --><dependency><groupId>org.keycloak</groupId><artifactId>keycloak-admin-client</artifactId><version>${keycloak.version}</version></dependency><!-- keycloak --><dependency><groupId>org.keycloak</groupId><artifactId>keycloak-spring-boot-starter</artifactId><version>${keycloak.version}</version></dependency></dependencies><dependencyManagement><dependencies><!-- keycloak --><dependency><groupId>org.keycloak.bom</groupId><artifactId>keycloak-adapter-bom</artifactId><version>${keycloak.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><excludes><exclude><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></exclude></excludes></configuration></plugin></plugins></build></project>

yml文件配置:

keycloak:
server:port: 5211keycloak:realm: springboot  #域名resource: kc-springboot  #客户端idauth-server-url: http://localhost:8080/ssl-required: externalpublic-client: false  #非public访问类型credentials:secret: AKauMGADJptxIWykGsJTRW1snJ6zAq2c #秘钥securityConstraints:- auth-roles:  # 公共页面  无权限可访问security-collections:- name: any- patterns:- /publicPage  - auth-roles: # 需要user或者admin权限才可访问- user- adminsecurity-collections:- name: user page- patterns:- /user  - auth-roles: # 需要admin权限才能访问- adminsecurity-collections:- name: adminpatterns:- /admin

上面的秘钥(credentials:secret)在客户端的凭据可以拿到。
credentials:secret

代码部分:

controller:

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;/*** @BelongsProject: keycloak-demo* @BelongsPackage: com.sky.keycloakdemo.controller* @Author: Sky.yu* @CreateTime: 2023-10-19  17:08* @Description: TODO* @Version: 1.0*/@Controller
public class HomeController {@GetMapping("/publicPage")public String home() {return "index";}@GetMapping("/user")public String user() {return "user";}@GetMapping("/admin")public String admin() {return "admin";}

设置好之后,在resources/templates目录下创建三个对应的页面。
resources

代码如下(简单的代码直接copy!):
index.html:

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
<h1>这里是公共页面!</h1>
</body>
</html>

admin.html

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
<h1>这里是管理员页面,只有admin权限才能访问</h1>
</body>
</html>

user.html

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Title</title>
</head>
<body>
<h1>这里是用户页面,拥有user、admin可访问!</h1>
</body>
</html>

到这里,这个简单的项目就完成了。

三、启动springboot项目

启动完成之后,访问路径:localhost:5211,会自动跳转到index.html。
index.html
让我们访问/user页面。
访问之后会跳转到keycloak自带的登录页面。
login
输入我们刚刚创建的用户user001,登录。
user-page

当我们用权限为user的账号访问/admin页面的时候,会出现什么问题呢?
在这里插入图片描述
显然无法访问。
在keycloak注销会话,然后在浏览器清除cookie,并且为这个用户添加一个admin的权限。
重新登录再试试!

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
再次访问 /admin 页面,就能访问成功了!
在这里插入图片描述
回到 /user 页面,也可以访问。
在这里插入图片描述
最重要的是yml文件的配置!!!!最重要的是yml文件的配置!!!!最重要的是yml文件的配置!!!!重要的事说三遍
yml

四、总结

总结一下本章的内容,最重要的还是是yml文件权限的配置,这将直接影响到你的接口校验是否生效。
其次就是客户端访问类型的设置和用户权限的问题。访问类型为public是不需要秘钥的。但是当我们选择其他两种访问类型,就需要配置秘钥了!

  credentials:secret: AKauMGADJptxIWykGsJTRW1snJ6zAq2c

到这里就结束了本章的内容,若有不对之处还请各位大佬指正。
有什么问题也可以评论区留言。谢谢~

纯后端项目在配置登录页以及需要手机号注册、手机号验证码登录登内容比较繁琐(需要自己写配置,比较烦,不是我懒哈Q.Q),时间不充分暂时就不写了,有问题的小伙伴也可以在评论区留个言,后面有时间了再考虑弄弄。
所以下一节内容我们先一起来玩一玩基于keycloak的前后端分离项目,前端不使用keycloak的情况下,如何使用自定义的前端(再次说一句改keycloak自带的前端真的挺烦的)和后端交互,包括手机号注册、登录、添加各种用户信息等等。
长路漫漫,代码作伴!大家一起学习一起进步!

这篇关于最详细的Keycloak教程(建议收藏):Keycloak实现手机号、验证码登陆——(二)Keycloak与SpringBoot的集成的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/244633

相关文章

Python pandas库自学超详细教程

《Pythonpandas库自学超详细教程》文章介绍了Pandas库的基本功能、安装方法及核心操作,涵盖数据导入(CSV/Excel等)、数据结构(Series、DataFrame)、数据清洗、转换... 目录一、什么是Pandas库(1)、Pandas 应用(2)、Pandas 功能(3)、数据结构二、安

Spring Boot集成/输出/日志级别控制/持久化开发实践

《SpringBoot集成/输出/日志级别控制/持久化开发实践》SpringBoot默认集成Logback,支持灵活日志级别配置(INFO/DEBUG等),输出包含时间戳、级别、类名等信息,并可通过... 目录一、日志概述1.1、Spring Boot日志简介1.2、日志框架与默认配置1.3、日志的核心作用

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门:一行代码实现优雅重试精细控制:让重试按我

破茧 JDBC:MyBatis 在 Spring Boot 中的轻量实践指南

《破茧JDBC:MyBatis在SpringBoot中的轻量实践指南》MyBatis是持久层框架,简化JDBC开发,通过接口+XML/注解实现数据访问,动态代理生成实现类,支持增删改查及参数... 目录一、什么是 MyBATis二、 MyBatis 入门2.1、创建项目2.2、配置数据库连接字符串2.3、入

Springboot项目启动失败提示找不到dao类的解决

《Springboot项目启动失败提示找不到dao类的解决》SpringBoot启动失败,因ProductServiceImpl未正确注入ProductDao,原因:Dao未注册为Bean,解决:在启... 目录错误描述原因解决方法总结***************************APPLICA编

深度解析Spring Security 中的 SecurityFilterChain核心功能

《深度解析SpringSecurity中的SecurityFilterChain核心功能》SecurityFilterChain通过组件化配置、类型安全路径匹配、多链协同三大特性,重构了Spri... 目录Spring Security 中的SecurityFilterChain深度解析一、Security

Redis客户端连接机制的实现方案

《Redis客户端连接机制的实现方案》本文主要介绍了Redis客户端连接机制的实现方案,包括事件驱动模型、非阻塞I/O处理、连接池应用及配置优化,具有一定的参考价值,感兴趣的可以了解一下... 目录1. Redis连接模型概述2. 连接建立过程详解2.1 连php接初始化流程2.2 关键配置参数3. 最大连

SpringBoot多环境配置数据读取方式

《SpringBoot多环境配置数据读取方式》SpringBoot通过环境隔离机制,支持properties/yaml/yml多格式配置,结合@Value、Environment和@Configura... 目录一、多环境配置的核心思路二、3种配置文件格式详解2.1 properties格式(传统格式)1.

Apache Ignite 与 Spring Boot 集成详细指南

《ApacheIgnite与SpringBoot集成详细指南》ApacheIgnite官方指南详解如何通过SpringBootStarter扩展实现自动配置,支持厚/轻客户端模式,简化Ign... 目录 一、背景:为什么需要这个集成? 二、两种集成方式(对应两种客户端模型) 三、方式一:自动配置 Thick

Python实现网格交易策略的过程

《Python实现网格交易策略的过程》本文讲解Python网格交易策略,利用ccxt获取加密货币数据及backtrader回测,通过设定网格节点,低买高卖获利,适合震荡行情,下面跟我一起看看我们的第一... 网格交易是一种经典的量化交易策略,其核心思想是在价格上下预设多个“网格”,当价格触发特定网格时执行买