最详细的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实现字节字符转bcd编码

《Java实现字节字符转bcd编码》BCD是一种将十进制数字编码为二进制的表示方式,常用于数字显示和存储,本文将介绍如何在Java中实现字节字符转BCD码的过程,需要的小伙伴可以了解下... 目录前言BCD码是什么Java实现字节转bcd编码方法补充总结前言BCD码(Binary-Coded Decima

SpringBoot全局域名替换的实现

《SpringBoot全局域名替换的实现》本文主要介绍了SpringBoot全局域名替换的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录 项目结构⚙️ 配置文件application.yml️ 配置类AppProperties.Ja

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC

JavaScript中的高级调试方法全攻略指南

《JavaScript中的高级调试方法全攻略指南》什么是高级JavaScript调试技巧,它比console.log有何优势,如何使用断点调试定位问题,通过本文,我们将深入解答这些问题,带您从理论到实... 目录观点与案例结合观点1观点2观点3观点4观点5高级调试技巧详解实战案例断点调试:定位变量错误性能分

Python实现批量CSV转Excel的高性能处理方案

《Python实现批量CSV转Excel的高性能处理方案》在日常办公中,我们经常需要将CSV格式的数据转换为Excel文件,本文将介绍一个基于Python的高性能解决方案,感兴趣的小伙伴可以跟随小编一... 目录一、场景需求二、技术方案三、核心代码四、批量处理方案五、性能优化六、使用示例完整代码七、小结一、

Java实现将HTML文件与字符串转换为图片

《Java实现将HTML文件与字符串转换为图片》在Java开发中,我们经常会遇到将HTML内容转换为图片的需求,本文小编就来和大家详细讲讲如何使用FreeSpire.DocforJava库来实现这一功... 目录前言核心实现:html 转图片完整代码场景 1:转换本地 HTML 文件为图片场景 2:转换 H

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1

C#实现一键批量合并PDF文档

《C#实现一键批量合并PDF文档》这篇文章主要为大家详细介绍了如何使用C#实现一键批量合并PDF文档功能,文中的示例代码简洁易懂,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言效果展示功能实现1、添加文件2、文件分组(书签)3、定义页码范围4、自定义显示5、定义页面尺寸6、PDF批量合并7、其他方法

SpringBoot实现不同接口指定上传文件大小的具体步骤

《SpringBoot实现不同接口指定上传文件大小的具体步骤》:本文主要介绍在SpringBoot中通过自定义注解、AOP拦截和配置文件实现不同接口上传文件大小限制的方法,强调需设置全局阈值远大于... 目录一  springboot实现不同接口指定文件大小1.1 思路说明1.2 工程启动说明二 具体实施2