最详细的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

相关文章

Java 正则表达式URL 匹配与源码全解析

《Java正则表达式URL匹配与源码全解析》在Web应用开发中,我们经常需要对URL进行格式验证,今天我们结合Java的Pattern和Matcher类,深入理解正则表达式在实际应用中... 目录1.正则表达式分解:2. 添加域名匹配 (2)3. 添加路径和查询参数匹配 (3) 4. 最终优化版本5.设计思

C#实现将Excel表格转换为图片(JPG/ PNG)

《C#实现将Excel表格转换为图片(JPG/PNG)》Excel表格可能会因为不同设备或字体缺失等问题,导致格式错乱或数据显示异常,转换为图片后,能确保数据的排版等保持一致,下面我们看看如何使用C... 目录通过C# 转换Excel工作表到图片通过C# 转换指定单元格区域到图片知识扩展C# 将 Excel

Java使用ANTLR4对Lua脚本语法校验详解

《Java使用ANTLR4对Lua脚本语法校验详解》ANTLR是一个强大的解析器生成器,用于读取、处理、执行或翻译结构化文本或二进制文件,下面就跟随小编一起看看Java如何使用ANTLR4对Lua脚本... 目录什么是ANTLR?第一个例子ANTLR4 的工作流程Lua脚本语法校验准备一个Lua Gramm

Java字符串操作技巧之语法、示例与应用场景分析

《Java字符串操作技巧之语法、示例与应用场景分析》在Java算法题和日常开发中,字符串处理是必备的核心技能,本文全面梳理Java中字符串的常用操作语法,结合代码示例、应用场景和避坑指南,可快速掌握字... 目录引言1. 基础操作1.1 创建字符串1.2 获取长度1.3 访问字符2. 字符串处理2.1 子字

Java Optional的使用技巧与最佳实践

《JavaOptional的使用技巧与最佳实践》在Java中,Optional是用于优雅处理null的容器类,其核心目标是显式提醒开发者处理空值场景,避免NullPointerExce... 目录一、Optional 的核心用途二、使用技巧与最佳实践三、常见误区与反模式四、替代方案与扩展五、总结在 Java

Linux内核参数配置与验证详细指南

《Linux内核参数配置与验证详细指南》在Linux系统运维和性能优化中,内核参数(sysctl)的配置至关重要,本文主要来聊聊如何配置与验证这些Linux内核参数,希望对大家有一定的帮助... 目录1. 引言2. 内核参数的作用3. 如何设置内核参数3.1 临时设置(重启失效)3.2 永久设置(重启仍生效

基于Java实现回调监听工具类

《基于Java实现回调监听工具类》这篇文章主要为大家详细介绍了如何基于Java实现一个回调监听工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录监听接口类 Listenable实际用法打印结果首先,会用到 函数式接口 Consumer, 通过这个可以解耦回调方法,下面先写一个

IDEA自动生成注释模板的配置教程

《IDEA自动生成注释模板的配置教程》本文介绍了如何在IntelliJIDEA中配置类和方法的注释模板,包括自动生成项目名称、包名、日期和时间等内容,以及如何定制参数和返回值的注释格式,需要的朋友可以... 目录项目场景配置方法类注释模板定义类开头的注释步骤类注释效果方法注释模板定义方法开头的注释步骤方法注

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

Qt中QGroupBox控件的实现

《Qt中QGroupBox控件的实现》QGroupBox是Qt框架中一个非常有用的控件,它主要用于组织和管理一组相关的控件,本文主要介绍了Qt中QGroupBox控件的实现,具有一定的参考价值,感兴趣... 目录引言一、基本属性二、常用方法2.1 构造函数 2.2 设置标题2.3 设置复选框模式2.4 是否