oauth2-sso-demo 的安装和配置教程

项目基础介绍

oauth2-sso-demo 是一个演示 OAuth2/OIDC 单点登录（SSO）的示例项目。该项目包含三个主要组件：授权服务器、待办事项 API 服务器和待办事项前端。通过这个项目，用户可以了解如何使用 Spring Boot 和 Spring Security 来实现 OAuth2/OIDC SSO 功能。

主要编程语言

• Java
• TypeScript
• Mustache
• CSS

项目使用的关键技术和框架

• Spring Boot：用于快速开发、运行和管理 Java 应用程序。
• Spring Security：为基于 Spring 的应用程序提供身份验证、授权和安全性。
• OAuth2：一个授权框架，允许第三方应用程序访问服务器资源，而不需要暴露用户的密码。
• OIDC：OpenID Connect，一个身份验证层，建立在 OAuth2 之上，用于验证用户的身份。
• Spring WebFlux：一个响应式编程框架，用于构建非阻塞的 Web 应用程序。
• React：用于构建用户界面的 JavaScript 库。

项目安装和配置的准备工作

在开始安装和配置之前，请确保以下环境已经安装在你的系统上：

• Java 21+：项目的 Java 运行环境。
• Docker：用于运行项目依赖的服务，如数据库和 Zipkin。

安装步骤

1. 克隆项目

   从命令行执行以下命令，将项目克隆到本地：

   git clone https://github.com/making/oauth2-sso-demo.git
   

2. 构建项目

   在项目根目录下，执行以下命令构建项目：

   ./mvnw clean install
   

3. 运行项目

   分别运行以下命令来启动授权服务器、待办事项 API 服务器和待办事项前端：

   ./mvnw spring-boot:run -f authorization -Dspring-boot.run.arguments="--spring.docker.compose.enabled=true --spring.docker.compose.file=$(pwd)/compose.yaml"
   ./mvnw spring-boot:run -f todo-api -Dspring-boot.run.arguments="--spring.docker.compose.enabled=true --spring.docker.compose.file=$(pwd)/compose.yaml"
   ./mvnw spring-boot:run -f todo-frontend -Dspring-boot.run.arguments="--spring.docker.compose.enabled=true --spring.docker.compose.file=$(pwd)/compose.yaml"
   

   或者如果你想要使用 WebFlux 版本的前端，运行以下命令：

   ./mvnw spring-boot:run -f todo-frontend-webflux -Dspring-boot.run.arguments="--spring.docker.compose.enabled=true --spring.docker.compose.file=$(pwd)/compose.yaml"
   

4. 访问项目

   项目运行后，打开浏览器访问 http://localhost:8080（待办事项前端）。如果是第一次访问，将被重定向到 http://127.0.0.1:9000（授权服务器）进行登录。

   使用以下默认用户信息登录：

   • 用户名：[e-mail]
   • 密码：password

   登录后，你可以添加新的待办事项或完成它们。

5. 关闭项目

   当你完成操作后，可以通过以下命令停止所有服务：

   pkill -TERM java
   docker compose down
   

请确保按照上述步骤操作，以成功安装和配置 oauth2-sso-demo 项目。