共用方式為


新增 Microsoft Entra 帳戶登入功能至 Spring Web 應用程式

本文說明如何開發支援透過 Microsoft Entra 帳戶登入的 Spring Web 應用程式。 完成本文中的所有步驟之後,Web 應用程式會在匿名存取時重新導向至 Microsoft Entra 登入頁面。 下列螢幕快照顯示 Microsoft Entra 登入頁面:

應用程式 [登入] 對話框的螢幕快照。

先決條件

完成本文中的步驟需要下列必要條件:

重要

需要 Spring Boot 2.5 版或更高版本,才能完成本文中的步驟。

使用 Spring Initializr 建立應用程式

  1. 瀏覽至 https://start.spring.io/

  2. 指定您想要使用 Java產生 Maven 項目,輸入應用程式的 群組Artifact 名稱。

  3. Spring Web、Microsoft Entra IDOAuth2 用戶端新增 相依項目

  4. 在頁面底部,選取 [GENERATE] 按鈕。

  5. 出現提示時,請將專案下載到本機計算機上的路徑。

建立 Microsoft Entra 實例

建立 Active Directory 實例

如果您是現有實例的系統管理員,您可以略過此程式。

  1. 登入 https://portal.azure.com

  2. 選取 所有服務,然後 身分識別,然後 Microsoft Entra ID

  3. 輸入您的 組織名稱初始網域名稱。 複製目錄的完整 URL。 您將在本教學課程稍後使用 URL 來新增使用者帳戶。 (例如:azuresampledirectory.onmicrosoft.com。)

    複製目錄的完整 URL。 您將在本教學課程稍後使用 URL 來新增使用者帳戶。 (例如:azuresampledirectory.onmicrosoft.com。)

    當您完成時,請選擇 建立。 建立新資源需要幾分鐘的時間。

  4. 完成時,選取顯示的連結以存取新目錄。

  5. 複製 租使用者識別碼。 在本教學課程的後續步驟中,您將使用 ID 值來配置 application.properties 檔案。

為您的 Spring Boot 應用程式新增註冊項目

  1. 從入口網站選單中,選取 [應用程式註冊],然後選取 [註冊應用程式

  2. 指定您的應用程式,然後選擇 註冊

  3. 當應用程式註冊的頁面出現時,請複製您的 應用程式(用戶端)標識碼目錄(租使用者)識別碼。 在本教學課程稍後,您將使用這些值來設定 application.properties 檔案。

  4. 在瀏覽窗格中選取 憑證 & 秘密。 然後,選取 新增客戶端密碼

    應用程式「憑證 & 秘密」的螢幕截圖,其中 [新增客戶端密碼] 已被醒目提示。

  5. 新增 說明,然後在 到期 列表中選擇持續時間。 選取 新增。 鍵值會自動填入。

  6. 複製並儲存客戶端密碼的值,以在本教學課程稍後的 application.properties 檔案中設定。 (您稍後將無法擷取此值。

    醒目提示新用戶端密碼的應用程式螢幕快照。

  7. 從應用程式註冊的主頁面,選取 驗證,然後選取 新增平臺。 然後選擇 Web 應用程式

  8. 針對新的 重新導向 URI,輸入 ,然後選取 [設定]。

  9. 如果您已修改 pom.xml 檔案,以使用早於 3.0.0 的 Microsoft Entra 入門版本:在 [隱含授與和混合式流程] 底下,選取 [標識符令牌 [用於隱含和混合式流程],然後選取 [儲存]。

將用戶帳戶新增至您的目錄,並將該帳戶新增至 appRole

  1. 從 Active Directory 的 [概觀] 頁面中,選取 [使用者],然後選取 [[新增使用者]。

  2. 顯示 [使用者] 面板時,輸入 [使用者名稱][名稱]。 然後選擇 [建立]。

    [新增使用者] 對話框的螢幕快照。

    注意

    當您輸入使用者名稱時,必須指定您在先前步驟中使用的目錄 URL。 例如:

    test-user@azuresampledirectory.onmicrosoft.com

  3. 從應用程式註冊的主頁面,選取 [應用程式角色],然後選取 [[建立應用程式角色]。 提供表單欄位的值,然後選取 [您要啟用此應用程式角色嗎?],接著選取 [套用]。

    [應用程式角色] 畫面的螢幕快照,其中顯示 [建立應用程式角色] 窗格。

  4. 從 Microsoft Entra 目錄的 [概觀] 頁面中,選取 [企業應用程式]。

  5. 選取 所有應用程式,然後選取您在先前一步中新增了應用程式角色的應用程式。

  6. 選取 [[使用者和群組],然後選取 [[新增使用者/群組]

  7. 使用者下,選取 未選取。 選取您稍早建立的使用者,選取 [選取],然後選取 [指派]。 如果您稍早建立了多個應用程式角色,請選取某個角色。

  8. 返回 [使用者] 面板,選取您的測試用戶,然後選取 [重設密碼],然後複製密碼。 在本教學課程稍後登入應用程式時,您將使用密碼。

設定和編譯您的應用程式

  1. 從您稍早在本教學課程中建立和下載的專案封存中擷取檔案到目錄。

  2. 流覽至專案中 src/main/resources 資料夾,然後在文本編輯器中開啟 application.properties 檔案。

  3. 使用您稍早建立的值來指定應用程式註冊的設定。 例如:

    # Enable related features.
    spring.cloud.azure.active-directory.enabled=true
    # Specifies your Active Directory ID:
    spring.cloud.azure.active-directory.profile.tenant-id=<tenant-ID>
    # Specifies your App Registration's Application ID:
    spring.cloud.azure.active-directory.credential.client-id=<client-ID>
    # Specifies your App Registration's secret key:
    spring.cloud.azure.active-directory.credential.client-secret=<client-secret>
    

    哪裡:

    參數 描述
    spring.cloud.azure.active-directory.enabled 啟用 spring-cloud-azure-starter-active-directory 所提供的功能
    spring.cloud.azure.active-directory.profile.tenant-id 包含您先前的 Active Directory 目錄識別碼
    spring.cloud.azure.active-directory.credential.client-id 包含您先前完成的應用程式註冊中的 應用程式識別碼
    spring.cloud.azure.active-directory.credential.client-secret 包含來自您稍早完成的應用程式註冊金鑰中的
  4. 儲存並關閉 application.properties 檔案。

  5. 在應用程式的 Java 源資料夾中,建立名為 控制器的資料夾。 例如:src/main/java/com/wingtiptoys/security/controller

  6. 控制器 資料夾中建立名為 HelloController.java 的新 Java 檔案,並在文本編輯器中開啟它。

  7. 輸入下列程式代碼,然後儲存並關閉檔案:

    package com.wingtiptoys.security;
    
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.security.access.prepost.PreAuthorize;
    
    @RestController
    public class HelloController {
         @GetMapping("Admin")
         @ResponseBody
         @PreAuthorize("hasAuthority('APPROLE_Admin')")
         public String Admin() {
             return "Admin message";
         }
    }
    

建置和測試您的應用程式

  1. 開啟命令提示字元,並將目錄變更為應用程式 pom.xml 檔案所在的資料夾。

  2. 使用 Maven 建置 Spring Boot 應用程式並加以執行。 例如:

    mvn clean package
    mvn spring-boot:run
    
  3. 在 Maven 建置並啟動您的應用程式之後,請在網頁瀏覽器中開啟 http://localhost:8080/Admin。 系統應該會提示您輸入使用者名稱和密碼。

    應用程式 [登入] 對話框的螢幕快照。

    注意

    如果這是新用戶帳戶的第一次登入,系統可能會提示您變更密碼。

    應用程式 [更新密碼] 對話框的螢幕快照。

  4. 成功登入之後,您應該會看到控制器中的範例「系統管理員訊息」文字。

    應用程式系統管理員訊息的螢幕快照。

總結

在本教學課程中,您已使用 Microsoft Entra 入門版建立新的 Java Web 應用程式、設定新的 Microsoft Entra 租使用者、在租用戶中註冊新的應用程式,然後將您的應用程式設定為使用 Spring 註釋和類別來保護 Web 應用程式。

另請參閱

後續步驟

若要深入瞭解 Spring 和 Azure,請繼續前往 Azure 上的 Spring 檔中心。