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

相关文章

Spring Security常见问题及解决方案

《SpringSecurity常见问题及解决方案》SpringSecurity是Spring生态的安全框架,提供认证、授权及攻击防护,支持JWT、OAuth2集成,适用于保护Spring应用,需配置... 目录Spring Security 简介Spring Security 核心概念1. ​Securit

Python实现终端清屏的几种方式详解

《Python实现终端清屏的几种方式详解》在使用Python进行终端交互式编程时,我们经常需要清空当前终端屏幕的内容,本文为大家整理了几种常见的实现方法,有需要的小伙伴可以参考下... 目录方法一:使用 `os` 模块调用系统命令方法二:使用 `subprocess` 模块执行命令方法三:打印多个换行符模拟

SpringBoot+EasyPOI轻松实现Excel和Word导出PDF

《SpringBoot+EasyPOI轻松实现Excel和Word导出PDF》在企业级开发中,将Excel和Word文档导出为PDF是常见需求,本文将结合​​EasyPOI和​​Aspose系列工具实... 目录一、环境准备与依赖配置1.1 方案选型1.2 依赖配置(商业库方案)二、Excel 导出 PDF

Python实现MQTT通信的示例代码

《Python实现MQTT通信的示例代码》本文主要介绍了Python实现MQTT通信的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 安装paho-mqtt库‌2. 搭建MQTT代理服务器(Broker)‌‌3. pytho

SpringBoot改造MCP服务器的详细说明(StreamableHTTP 类型)

《SpringBoot改造MCP服务器的详细说明(StreamableHTTP类型)》本文介绍了SpringBoot如何实现MCPStreamableHTTP服务器,并且使用CherryStudio... 目录SpringBoot改造MCP服务器(StreamableHTTP)1 项目说明2 使用说明2.1

spring中的@MapperScan注解属性解析

《spring中的@MapperScan注解属性解析》@MapperScan是Spring集成MyBatis时自动扫描Mapper接口的注解,简化配置并支持多数据源,通过属性控制扫描路径和过滤条件,利... 目录一、核心功能与作用二、注解属性解析三、底层实现原理四、使用场景与最佳实践五、注意事项与常见问题六

Spring的RedisTemplate的json反序列泛型丢失问题解决

《Spring的RedisTemplate的json反序列泛型丢失问题解决》本文主要介绍了SpringRedisTemplate中使用JSON序列化时泛型信息丢失的问题及其提出三种解决方案,可以根据性... 目录背景解决方案方案一方案二方案三总结背景在使用RedisTemplate操作redis时我们针对

Java中Arrays类和Collections类常用方法示例详解

《Java中Arrays类和Collections类常用方法示例详解》本文总结了Java中Arrays和Collections类的常用方法,涵盖数组填充、排序、搜索、复制、列表转换等操作,帮助开发者高... 目录Arrays.fill()相关用法Arrays.toString()Arrays.sort()A

Spring Boot Maven 插件如何构建可执行 JAR 的核心配置

《SpringBootMaven插件如何构建可执行JAR的核心配置》SpringBoot核心Maven插件,用于生成可执行JAR/WAR,内置服务器简化部署,支持热部署、多环境配置及依赖管理... 目录前言一、插件的核心功能与目标1.1 插件的定位1.2 插件的 Goals(目标)1.3 插件定位1.4 核

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter