メインコンテンツにスキップ

Spring Boot

casdoor-spring-boot-exampleは、Spring Bootプロジェクトでcasdoor-spring-boot-starterを使用する方法の例です。 以下のステップをご案内します。

ステップ1: Casdoorのデプロイ​

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

ステップ2: casdoor-spring-boot-starterのインポート​

MavenまたはGradleを使用してcasdoor-spring-boot-starterをインポートできます。

<!-- 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>

ステップ3: 設定の初期化​

初期化には、以下の順番で6つの文字列型パラメータが必要です：

名前必須説明
endpointはいCasdoorサーバーURL、例：http://localhost:8000
clientIdはいアプリケーションクライアントID
clientSecretはいアプリケーションクライアントシークレット
certificateはいアプリケーション証明書
organizationNameはいアプリケーション組織
applicationNameいいえアプリケーション名
初期化にはJavaプロパティまたは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
注意

特にclientId、clientSecret、jwtPublicKeyについては、自分のCasdoorインスタンスの設定値に置き換えてください。

ステップ4: ログインページへのリダイレクト​

To authenticate users, redirect them to Casdoor’s login page (with the target URL as needed). Make sure you have added the callback URL (e.g. http://localhost:8080/login) in the application configuration beforehand.

@Resource
private CasdoorAuthService casdoorAuthService;

@RequestMapping("toLogin")
public String toLogin() {
    return "redirect:" + casdoorAuthService.getSigninUrl("http://localhost:8080/login");
}

ステップ5: トークンの取得と解析​

Casdoorの検証が通過すると、コードとステートを含むアプリケーションにリダイレクトされます。

コードを取得してgetOAuthTokenメソッドを呼び出し、JWTトークンを解析できます。

CasdoorUserには、Casdoorによって提供されるユーザーの基本情報が含まれています。 それを使用してアプリケーションでセッションを設定できます。

@RequestMapping("login")
public String login(String code, String state, HttpServletRequest request) {
    String token = "";
    CasdoorUser user = null;
    try {
        token = casdoorAuthService.getOAuthToken(code, state);
        user = casdoorAuthService.parseJwtToken(token);
    } catch (CasdoorAuthException e) {
        e.printStackTrace();
    }
    HttpSession session = request.getSession();
    session.setAttribute("casdoorUser", user);
    return "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());

その他のリソース​

JavaとCasdoorの統合についてもっと学ぶために、以下のプロジェクト/ドキュメントを探索できます：