Zum Hauptinhalt springen

RuoYi

Casdoor kann leicht mit RuoYi-Cloud integriert werden.

Schritt 1: Casdoor bereitstellen​

Deploy Casdoor. See Server installation. Ensure the server is running (e.g. http://localhost:8000) and you can open the login page (e.g. http://localhost:7001) and sign in with admin / 123.

Schritt 2: Casdoor konfigurieren​

Konfigurieren Sie eine Organisation, eine Anwendung und den Synchronisierer in Casdoor. Notes:

  1. When editing the syncer, check the table columns: Table Columns.
  2. When editing the organization, select the correct password type: Password Type.
  3. Enable soft deletion.

Schritt 3. Reformieren Sie Ihr Front-End​

3.1 Springen Sie zur Casdoor-Login-Seite​

Use a frontend SDK (e.g. vue-sdk). After initializing it, get the Casdoor login URL with getSigninUrl().

Wire the link as needed and remove any redundant RuoYi-Cloud login UI (e.g. account/password inputs).

3.2 Akzeptieren Sie den Code und den Zustand, die von Casdoor zurückgesendet werden​

Nach erfolgreichem Login über Casdoor sendet Casdoor den Code und den Zustand an die von uns eingerichtete Seite. Wir können den Code und den Zustand mit der Funktion create() abrufen.

created() {
    let url = window.document.location.href; // get URL
    let u = new URL(url);
    this.loginForm.code = u.searchParams.get('code'); // get code and state
    this.loginForm.state = u.searchParams.get('state');
    if (this.loginForm.code != null && this.loginForm.state != null) { // if code and state are not null, execute handleLogin
      this.handleLogin();
    }  
}

Für RuoYi-Cloud ändern wir einfach seine ursprüngliche Methode, das Konto und das Passwort zu senden, um stattdessen den Code und den Zustand zu senden. Daher ändert sich nur, was an das Backend gesendet wird, im Verhältnis zum ursprünglichen Login.

Schritt 4: Refaktorisieren Sie Ihr Backend​

4.1 Akzeptieren Sie den Code und den Zustand, die vom Front-End zurückgesendet werden​

@PostMapping("login")
public R<?> callback(@RequestBody CodeBody code) {
    String token = casdoorAuthService.getOAuthToken(code.getCode(), code.getState());
    CasdoorUser casdoorUser = casdoorAuthService.parseJwtToken(token);
    if (casdoorUser.getName() != null) {
        String casdoorUserName = casdoorUser.getName();
        if (sysLoginService.getUserByCasdoorName(casdoorUserName) == null) {
            sysLoginService.casdoorRegister(casdoorUserName); // Add this user to the database if they don't exist
        }
    }
    LoginUser userInfo = sysLoginService.casdoorLogin(casdoorUser.getName()); // Get the user's information from the database
    return R.ok(tokenService.createToken(userInfo));
}

In dieser Methode verwenden wir die casdoor-SpringBoot-sdk-Methode und nehmen leichte Änderungen an der RuoYi-Cloud-Methode vor.

Zum Beispiel registriert die ursprüngliche Methode von RuoYi-Cloud ein Konto mit einem Passwort. Ich habe es geändert, um ein Konto mit der Methode casdoorRegister zu registrieren.

Ich habe auch eine Methode getUserByCasdoorName hinzugefügt, um zu überprüfen, ob das Konto existiert, und die Methode executeUserInfo in executeWithAccount geändert, um diese Änderung widerzuspiegeln.

Dies ist eine einfache Änderung, da wir nur den Teil entfernen müssen, der das Passwort überprüft.

Schritt 5: Zusammenfassung​

5.1 Front-End​

  • Die bestehenden Login- und Registrierungsseiten müssen entfernt werden.
  • Zusätzlich muss das Front-End Code- und Zustandsparameter akzeptieren und diese an das Backend senden.

5.2 Backend​

Das RuoYi-Backend verfügt bereits über eine gut implementierte Login- und Registrierungsfunktion. Wir müssen nur einige geringfügige Änderungen vornehmen, was den Prozess sehr bequem macht.

Schritt 6: Detaillierte Schritte​

  1. Bereitstellen und konfigurieren Sie Casdoor. Stellen Sie sicher, dass Sie den bcrypt-Passworttyp für die Organisation auswählen, da RuoYi-Cloud auch bcrypt für Passwörter verwendet.

  2. Verwenden Sie Casdoor-Synchronisierer, um Datenbankbenutzer in Ihre Casdoor-Organisation zu kopieren. Dies wird die ursprünglichen Konten in Casdoor importieren.

  3. Nach der Bereitstellung von Casdoor, nehmen Sie Änderungen am Front-End vor. Deaktivieren Sie den RuoYi-Prüfcode.

    checkcode Schalter

    Beachten Sie, dass der RuoYi-Cloud-Captcha in Nacos erneut deaktiviert werden muss. Außerdem muss die RuoYi-Cloud-Registrierungsfunktion aktiviert werden, indem sys.account.registerUser auf true gesetzt wird.

  4. Fügen Sie einen Button hinzu, damit Benutzer sich mit Casdoor anmelden können, und ändern Sie die Daten des loginForm.

    Login-Button data loginForm The URL can also be obtained from Casdoor-Vue-SDK or Casdoor-SpringBoot-SDK.

  5. Da wir die ursprüngliche Login-Methode nicht mehr verwenden, löschen Sie die Cookie- und Checkcode-Methoden.

    Die neue created-Funktion sollte so aussehen:

    created() {
        let url = window.document.location.href; // Get the URL
        let u = new URL(url);
        this.loginForm.code = u.searchParams.get('code'); // Get the code and state
        this.loginForm.state = u.searchParams.get('state');
        if (this.loginForm.code != null && this.loginForm.state != null) { // If code and state are not null, execute handleLogin
            this.handleLogin();
        }  
    }

  6. Tatsächlich müssen wir nur den Parameter ändern, den wir an das Backend senden, und die unnötigen Funktionen löschen. Keine weiteren Änderungen sind notwendig.

    handleLogin Login login

  7. Importieren Sie die erforderliche Abhängigkeit im Backend.

    pom.xml
    <dependency>
        <groupId>org.casbin</groupId>
        <artifactId>casdoor-spring-boot-starter</artifactId>
        <version>1.2.0</version>
    </dependency>

    Sie müssen auch Casdoor in der Ressourcendatei konfigurieren.

  8. Definieren Sie die Callback-Funktion als die Redirect-Funktion. Nehmen Sie Änderungen an einigen Methoden in sysLoginService vor. Löschen Sie den Passwortprüfschritt, da er nicht mehr benötigt wird.

    @PostMapping("login")
    public R<?> callback(@RequestBody CodeBody code) {
        // Define a CodeBody entity with code and state
        String token = casdoorAuthService.getOAuthToken(code.getCode(), code.getState());
        CasdoorUser casdoorUser = casdoorAuthService.parseJwtToken(token);
        if (casdoorUser.getName() != null) {
            String casdoorUserName = casdoorUser.getName();
            if (sysLoginService.getUserByCasdoorName(casdoorUserName) == null) {
                // If the user is not in the RuoYi-Cloud database but exists in Casdoor, create the user in the database
                sysLoginService.casdoorRegister(casdoorUserName);
            }
        }
        LoginUser userInfo = sysLoginService.casdoorLogin(casdoorUser.getName());
        // Get the user's information from the database
        return R.ok(tokenService.createToken(userInfo));
    }

  9. Fügen Sie neue Methoden zu SysLoginService hinzu.

    public LoginUser casdoorLogin(String username) {
        R<LoginUser> userResult = remoteUserService.getUserInfo(username, SecurityConstants.INNER);
        // Execute the user
        if (R.FAIL == userResult.getCode()) {
            throw new ServiceException(userResult.getMsg());
        }

        if (StringUtils.isNull(userResult) || StringUtils.isNull(userResult.getData())) {
            recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "This user does not exist");
            throw new ServiceException("User " + username + " does not exist");
        }
        LoginUser userInfo = userResult.getData();
        SysUser user = userResult.getData().getSysUser();
        if (UserStatus.DELETED.getCode().equals(user.getDelFlag())) {
            recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "Sorry, your account has been deleted");
            throw new ServiceException("Sorry, your account " + username + " has been deleted");
        }
        if (UserStatus.DISABLE.getCode().equals(user.getStatus())) {
            recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "Your account is disabled. Please contact the administrator");
            throw new ServiceException("Sorry, your account " + username + " is disabled");
        }
        recordLogService.recordLogininfor(username, Constants.LOGIN_SUCCESS, "Login successful");
        return userInfo;
    }
    public String getUserByCasdoorName(String casdoorUsername) {
        R<LoginUser> userResult = remoteUserService.getUserInfo(casdoorUsername, SecurityConstants.INNER);
        if (StringUtils.isNull(userResult) || StringUtils.isNull(userResult.getData())) {
            // If the user is not in the RuoYi-Cloud database but exists in Casdoor, create the user in the database
            return null;
        }
        String username = userResult.getData().getSysUser().getUserName();
        return username;
    }
    public void casdoorRegister(String username) {
        if (StringUtils.isAnyBlank(username)) {
            throw new ServiceException("User must provide a username");
        }
        SysUser sysUser = new SysUser();
        sysUser.setUserName(username);
        sysUser.setNickName(username);
        R<?> registerResult = remoteUserService.registerUserInfo(sysUser, SecurityConstants.INNER);
        System.out.println(registerResult);
        if (R.FAIL == registerResult.getCode()) {
            throw new ServiceException(registerResult.getMsg());
        }
        recordLogService.recordLogininfor(username, Constants.REGISTER, "Registration successful");
    }