配置参考

Beacon SSO Java SDK 通过 application.yml / application.properties 中的 beacon.sso.* 属性进行配置。

核心配置

必填配置

属性	说明	示例
`beacon.sso.base-url`	SSO 服务器基础 URL	`https://sso.example.com`
`beacon.sso.client-id`	OAuth2 客户端 ID	`my-app-client`
`beacon.sso.client-secret`	OAuth2 客户端 Secret	`secret-key-xxx`
`beacon.sso.redirect-uri`	OAuth2 回调地址	`http://localhost:8080/oauth/callback`

可选配置

属性	说明	默认值
`beacon.sso.enabled`	SDK 总开关	`true`
`beacon.sso.exclude-urls`	Filter 排除路径（Ant 风格匹配）	空
`beacon.sso.well-known-uri`	OIDC Well-Known 自动发现 URI	空

OAuth2 端点配置

SDK 内置了默认的端点路径，通常无需手动配置：

属性	默认值	说明
`beacon.sso.endpoints.auth-uri`	`/oauth/authorize`	授权端点
`beacon.sso.endpoints.token-uri`	`/oauth/token`	令牌端点
`beacon.sso.endpoints.userinfo-uri`	`/oauth/userinfo`	用户信息端点
`beacon.sso.endpoints.introspection-uri`	`/oauth/introspect`	令牌自省端点
`beacon.sso.endpoints.revocation-uri`	`/oauth/revoke`	令牌注销端点

以上端点路径会与 beacon.sso.base-url 拼接成完整 URL。例如 base-url 为 https://sso.example.com 时，Token 端点为 https://sso.example.com/oauth/token。

路由前缀配置

SDK 自动注册的 Controller 路径前缀均可自定义：

属性	默认值	说明
`beacon.sso.oauth-path`	`/oauth`	OAuth2 路由前缀
`beacon.sso.account-path`	`/account`	账户路由前缀
`beacon.sso.user-path`	`/user`	用户路由前缀
`beacon.sso.public-path`	`/public`	公共路由前缀
`beacon.sso.merchant-path`	`/merchant`	商户路由前缀

例如将 OAuth 路由前缀改为 /sso：

beacon:
  sso:
    oauth-path: /sso

则登录路由变为 /sso/login，回调路由变为 /sso/callback。

gRPC 配置

gRPC 默认关闭，需要手动启用：

必填配置（启用 gRPC 时）

属性	说明	示例
`beacon.sso.grpc.enabled`	启用 gRPC	`true`
`beacon.sso.grpc.host`	gRPC 服务器地址	`sso.example.com`
`beacon.sso.grpc.port`	gRPC 服务器端口	`5566`
`beacon.sso.grpc.app-access-id`	应用凭证 ID	`app-xxx`
`beacon.sso.grpc.app-secret-key`	应用凭证密钥	`secret-xxx`

Well-Known 自动发现

如果你配置了 beacon.sso.well-known-uri，SDK 会在启动时自动从该端点获取 OAuth2 端点配置：

authorization_endpoint
token_endpoint
userinfo_endpoint
introspection_endpoint
revocation_endpoint

配置 well-known-uri 后，无需手动配置 beacon.sso.endpoints.* 相关属性。自动发现仅覆盖仍为默认值的端点路径。

完整配置示例

基础配置（仅 OAuth2）

beacon:
  sso:
    base-url: https://sso.example.com
    client-id: my-app-client
    client-secret: secret-key-xxx
    redirect-uri: http://localhost:8080/oauth/callback
    exclude-urls:
      - /api/public/**
      - /actuator/**

完整配置（OAuth2 + gRPC）

beacon:
  sso:
    base-url: https://sso.example.com
    client-id: my-app-client
    client-secret: secret-key-xxx
    redirect-uri: http://localhost:8080/oauth/callback
    exclude-urls:
      - /api/public/**
    grpc:
      enabled: true
      host: sso.example.com
      port: 5566
      app-access-id: app-xxx
      app-secret-key: secret-xxx

使用 Well-Known 自动发现

beacon:
  sso:
    base-url: https://sso.example.com
    client-id: my-app-client
    client-secret: secret-key-xxx
    redirect-uri: http://localhost:8080/oauth/callback
    well-known-uri: https://sso.example.com/.well-known/openid-configuration
    grpc:
      enabled: true
      host: sso.example.com
      port: 5566
      app-access-id: app-xxx
      app-secret-key: secret-xxx

配置参考

On this page