当前位置：首页 > news >正文

Spring Boot中整合Keycloak OpenID Connect（OIDC）

news 2025/7/26 20:54:53

在Spring Boot中整合Keycloak OpenID Connect（OIDC）是一个常见的任务，用于实现身份验证和授权。Keycloak是一个开源的身份和访问管理解决方案，而OpenID Connect是构建在OAuth 2.0之上的认证和授权协议。下面是一个简单的步骤指南，用于在Spring Boot应用程序中整合Keycloak OIDC：

1. **创建Keycloak Realm**：
- 在Keycloak管理员控制台中创建一个新的Realm，用于管理你的应用程序的身份验证和授权。

2. **创建Client**：
- 在Realm中创建一个Client，用于表示你的Spring Boot应用程序。选择"openid-connect"作为Client Protocol，并设置有效的重定向URI等。

3. **添加依赖**：
- 在你的Spring Boot项目的`pom.xml`文件中添加Keycloak Spring Boot Starter依赖。例如：
```xml
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-spring-boot-starter</artifactId>
</dependency>
```

4. **配置application.properties/application.yml**：
- 在Spring Boot的配置文件中，添加Keycloak相关的配置，包括Realm、Client ID、Client Secret等。例如：
```properties
keycloak.realm=your-realm
keycloak.resource=your-client-id
keycloak.credentials.secret=your-client-secret
keycloak.auth-server-url=http://your-keycloak-server/auth
keycloak.ssl-required=external
keycloak.use-resource-role-mappings=true
```

5. **配置Security配置类**：
- 创建一个类来配置Spring Security，以启用Keycloak的OIDC集成。例如：
```java
import org.keycloak.adapters.springboot.KeycloakSpringBootConfigResolver;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

@Bean
public KeycloakSpringBootConfigResolver keycloakConfigResolver() {
return new KeycloakSpringBootConfigResolver();
}

@Override
protected void configure(HttpSecurity http) throws Exception {
super.configure(http);
http
.authorizeRequests()
.antMatchers("/public/**").permitAll()
.anyRequest().authenticated();
}
}
```

6. **保护资源**：
- 在你的应用程序中，你可以使用Spring Security的注解来保护需要认证的资源。例如：
```java
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

@GetMapping("/secured")
public String securedEndpoint() {
return "This is a secured endpoint!";
}
}
```