Spring OAuth2 Keycloak Connector 使用教程

1. 项目的目录结构及介绍

spring-oauth2-keycloak-connector/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── keycloak/
│   │   │               ├── config/
│   │   │               ├── controller/
│   │   │               ├── service/
│   │   │               └── KeycloakConnectorApplication.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── application-dev.properties
│   └── test/
│       └── java/
│           └── com/
│               └── example/
│                   └── keycloak/
│                       └── KeycloakConnectorApplicationTests.java
├── .gitignore
├── LICENSE
├── README.md
├── pom.xml

目录结构说明

• src/main/java/com/example/keycloak/: 包含主要的Java源代码。
  • config/: 配置类，如安全配置、Keycloak配置等。
  • controller/: 控制器类，处理HTTP请求。
  • service/: 服务类，处理业务逻辑。
  • KeycloakConnectorApplication.java: 项目启动类。
• src/main/resources/: 包含资源文件，如配置文件。
  • application.properties: 主配置文件。
  • application-dev.properties: 开发环境配置文件。
• src/test/java/com/example/keycloak/: 包含测试类。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• pom.xml: Maven项目配置文件。

2. 项目的启动文件介绍

KeycloakConnectorApplication.java

package com.example.keycloak;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class KeycloakConnectorApplication {

    public static void main(String[] args) {
        SpringApplication.run(KeycloakConnectorApplication.class, args);
    }
}

启动文件说明

• KeycloakConnectorApplication.java 是项目的启动类，使用 @SpringBootApplication 注解标记，表示这是一个Spring Boot应用程序。
• main 方法中调用 SpringApplication.run 方法启动应用程序。

3. 项目的配置文件介绍

application.properties

# Keycloak配置
keycloak.auth-server-url=http://localhost:8080/auth
keycloak.realm=demo
keycloak.resource=client
keycloak.public-client=true
keycloak.principal-attribute=preferred_username

# 服务器配置
server.port=8081

# 日志配置
logging.level.org.springframework.security=DEBUG

配置文件说明

• keycloak.auth-server-url: Keycloak认证服务器的URL。
• keycloak.realm: Keycloak领域名称。
• keycloak.resource: 客户端名称。
• keycloak.public-client: 是否为公共客户端。
• keycloak.principal-attribute: 用户主体属性。
• server.port: 应用程序运行端口。
• logging.level.org.springframework.security: 日志级别配置。

通过以上配置，可以连接到Keycloak服务器并进行身份验证和授权。