Spring Cloud Gateway

Приклад casdoor-springcloud-gateway-example показує, як використовувати casdoor-spring-boot-starter як плагін OAuth2 у Spring Cloud Gateway. Нижче описані кроки його використання.

Крок 1: Розгортання Casdoor

Deploy Casdoor in production mode. See Server installation. Ensure the server is reachable and you can sign in at the login page (e.g. admin / 123).

Крок 2: Ініціалізація Spring Cloud Gateway

Use the example code as-is or adapt it to your application.

Вам потрібен сервіс шлюзу та принаймні один бізнес-сервіс. У цьому прикладі, casdoor-gateway є сервісом шлюзу, а casdoor-api - бізнес-сервісом.

Крок 3: Додавання залежності

Додайте залежність casdoor-spring-boot-starter до вашого проекту Spring Cloud Gateway.

Для Apache Maven:

/casdoor-gateway/pom.xml
<!-- https://mvnrepository.com/artifact/org.casbin/casdoor-spring-boot-starter -->
<dependency>
    <groupId>org.casbin</groupId>
    <artifactId>casdoor-spring-boot-starter</artifactId>
    <version>1.x.y</version>
</dependency>

Для Gradle:

// https://mvnrepository.com/artifact/org.casbin/casdoor-spring-boot-starter
implementation group: 'org.casbin', name: 'casdoor-spring-boot-starter', version: '1.x.y'

Крок 4: Налаштування ваших властивостей

Для ініціалізації потрібно 6 параметрів, всі вони мають тип string.

Назва (за порядком)	Необхідно	Опис
endpoint	Так	URL-адреса сервера Casdoor, наприклад, `http://localhost:8000`
clientId	Так	Application.client_id
clientSecret	Так	Application.client_secret
certificate	Так	Application.certificate
organizationName	Так	Application.organization
applicationName	Ні	Application.name

Initialize these parameters via Java properties or YAML.

Для властивостей:

casdoor.endpoint=http://localhost:8000
casdoor.clientId=<client-id>
casdoor.clientSecret=<client-secret>
casdoor.certificate=<certificate>
casdoor.organizationName=built-in
casdoor.applicationName=app-built-in

Для YAML:

casdoor:
  endpoint: http://localhost:8000
  client-id: <client-id>
  client-secret: <client-secret>
  certificate: <certificate>
  organization-name: built-in
  application-name: app-built-in

Configure gateway routing as well. Для YAML:

spring:
  application:
    name: casdoor-gateway
  cloud:
    gateway:
      routes:
        - id: api-route
          uri: http://localhost:9091
          predicates:
            - Path=/api/**

Крок 5: Додавання CasdoorAuthFilter

Додайте клас реалізації інтерфейсу GlobalFilter до шлюзу для перевірки ідентичності, наприклад, CasdoorAuthFilter, який використовується у цьому прикладі.

Якщо аутентифікація не вдається, він повертає статус-код 401 на фронтенд, щоб перенаправити їх на інтерфейс входу.

@Component
public class CasdoorAuthFilter implements GlobalFilter, Ordered {

    private static final Logger LOGGER = LoggerFactory.getLogger(CasdoorAuthFilter.class);

    @Override public int getOrder() {
        return 0;
    }

    @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        return exchange.getSession().flatMap(webSession -> {
            CasdoorUser user = webSession.getAttribute("casdoorUser");
            if (user != null) {
                return chain.filter(exchange);
            }
            ServerHttpResponse response = exchange.getResponse();
            response.setStatusCode(HttpStatus.UNAUTHORIZED);
            response.getHeaders().add("Content-Type", "application/json");
            return response.setComplete();
        });
    }
}

Крок 6: Отримання сервісу та його використання

Тепер надається 5 сервісів: CasdoorAuthService, CasdoorUserService, CasdoorEmailService, CasdoorSmsService та CasdoorResourceService.

Create them in the Gateway project as follows.

@Resource
private CasdoorAuthService casdoorAuthService;

When the app requires authentication, redirect to Casdoor's login page with the target URL.

Add the callback URL (e.g. http://localhost:9090/callback) to the Casdoor application in advance.

@RequestMapping("login")
public Mono<String> login() {
    return Mono.just("redirect:" + casdoorAuthService.getSigninUrl("http://localhost:9090/callback"));
}

After Casdoor verifies the user, the app is redirected back with a code and state; use the code and getOAuthToken to obtain the JWT.

CasdoorUser holds the user info from Casdoor; use it to establish the session in your app.

@RequestMapping("callback")
public Mono<String> callback(String code, String state, ServerWebExchange exchange) {
    String token = "";
    CasdoorUser user = null;
    try {
        token = casdoorAuthService.getOAuthToken(code, state);
        user = casdoorAuthService.parseJwtToken(token);
    } catch(CasdoorAuthException e) {
        e.printStackTrace();
    }
    CasdoorUser finalUser = user;
    return exchange.getSession().flatMap(session -> {
        session.getAttributes().put("casdoorUser", finalUser);
        return Mono.just("redirect:/");
    });
}

Приклади API показані нижче.

CasdoorAuthService
- String token = casdoorAuthService.getOAuthToken(code, "app-built-in");
- CasdoorUser casdoorUser = casdoorAuthService.parseJwtToken(token);
CasdoorUserService
- CasdoorUser casdoorUser = casdoorUserService.getUser("admin");
- CasdoorUser casdoorUser = casdoorUserService.getUserByEmail("admin@example.com");
- CasdoorUser[] casdoorUsers = casdoorUserService.getUsers();
- CasdoorUser[] casdoorUsers = casdoorUserService.getSortedUsers("created_time", 5);
- int count = casdoorUserService.getUserCount("0");
- CasdoorResponse response = casdoorUserService.addUser(user);
- CasdoorResponse response = casdoorUserService.updateUser(user);
- CasdoorResponse response = casdoorUserService.deleteUser(user);
CasdoorEmailService
- CasdoorResponse response = casdoorEmailService.sendEmail(title, content, sender, receiver);
CasdoorSmsService
- CasdoorResponse response = casdoorSmsService.sendSms(randomCode(), receiver);
CasdoorResourceService
- CasdoorResponse response = casdoorResourceService.uploadResource(user, tag, parent, fullFilePath, file);
- CasdoorResponse response = casdoorResourceService.deleteResource(file.getName());

Крок 7: Перезапуск проекту

After starting the project, open your favorite browser and visit http://localhost:9090. Потім натисніть будь-яку кнопку, яка запитує ресурси з casdoor-api.

індекс