共用方式為


快速入門:從 Java Web 應用程式登入使用者並呼叫 Microsoft Graph API

在本快速入門中,您會下載並執行程式代碼範例,示範 Java Web 應用程式如何登入使用者,並呼叫 Microsoft Graph API。 任何Microsoft Entra 組織的使用者都可以登入應用程式。

如需說明,請參閱 範例的運作方式

先決條件

若要執行此範例,您需要:

註冊並下載您的快速入門應用程式

有兩種方式可以啟動您的快速入門應用程式:express (選項 1) 和手動 (選項 2)。

選項 1:註冊並自動設定您的應用程式,然後下載程式代碼範例

  1. 移至 Microsoft Entra 系統管理中心 - 應用程式註冊 快速入門體驗,至少 雲端應用程式管理員
  2. 輸入應用程式的名稱,然後選擇 [註冊]
  3. 請遵循入口網站快速入門體驗中的指示,下載自動設定的應用程式程序代碼。

選項 2:註冊並手動設定應用程式和程式碼範例

步驟 1:註冊您的應用程式

若要註冊您的應用程式,並手動新增應用程式的註冊資訊,請遵循下列步驟:

  1. 以至少 雲端應用程式管理員身分登入 Microsoft Entra 系統管理中心
  2. 如果您有多個租使用者的存取權,請使用頂端功能表中的 [設定] 圖示 ,切換至您想要從 [目錄 + 訂用帳戶] 功能表註冊應用程式的租使用者。
  3. 瀏覽至 [身分識別>應用程式>應用程式註冊],然後選取 [[新增註冊]
  4. 輸入應用程式的 名稱,例如 java-webapp。 您的應用程式使用者可能會看到此名稱。 您可以稍後加以變更。
  5. 選取 [[註冊]。
  6. 在 [概觀] 頁面上,記下 [應用程式 ID] 和 [租使用者 (目錄) ID]。 您稍後會需要這些值。
  7. 在 [管理] 下,選取 [驗證]。
  8. 選取 新增平臺>Web
  9. 在 [重新導向 URI] 區段中,輸入 https://localhost:8443/msal4jsample/secure/aad
  10. 選擇 [] 並配置 []。
  11. 在 [Web] 區段中,於 [重新導向 URI] 底下,輸入 https://localhost:8443/msal4jsample/graph/me 作為第二個重新導向 URI。
  12. 在 [管理] 底下,選取 [憑證] [& 秘密]。 在 [客戶端密碼] 區段中,選取 [[新增客戶端密碼]
  13. 輸入金鑰描述(例如,應用程式秘密),保留預設到期日,然後選取 [新增 ]。
  14. 請注意客戶端密碼 。 您稍後會用到它。

步驟 2:下載程式代碼範例

下載程式代碼範例

步驟 3:設定程式碼範例

  1. 將 zip 檔案解壓縮到本機資料夾。

  2. 自選。 如果您使用整合開發環境,請在該環境中開啟範例。

  3. 開啟 application.properties 檔案。 您可以在 src/main/resources/ 資料夾中找到它。 分別以應用程式識別碼、租使用者標識碼和客戶端密碼值取代欄位 aad.clientIdaad.authorityaad.secretKey 中的值。 其外觀如下:

     aad.clientId=Enter_the_Application_Id_here
     aad.authority=https://login.microsoftonline.com/Enter_the_Tenant_Info_Here/
     aad.secretKey=Enter_the_Client_Secret_Here
     aad.redirectUriSignin=https://localhost:8443/msal4jsample/secure/aad
     aad.redirectUriGraph=https://localhost:8443/msal4jsample/graph/me
     aad.msGraphEndpointHost="https://graph.microsoft.com/"
    

在先前的程式代碼中:

  • Enter_the_Application_Id_here 是您註冊之應用程式的應用程式識別碼。
  • Enter_the_Client_Secret_Here 是您針對所註冊應用程式在 憑證 & 秘密 中建立 客戶端密碼
  • Enter_the_Tenant_Info_Here 是您註冊應用程式的 目錄(租戶)ID 的 值。
  1. 若要搭配localhost使用 HTTPS,請提供 server.ssl.key 屬性。 若要產生自我簽署憑證,請使用keytool公用程式(包含在 JRE 中)。

以下是範例:

keytool -genkeypair -alias testCert -keyalg RSA -storetype PKCS12 -keystore keystore.p12 -storepass password

server.ssl.key-store-type=PKCS12
server.ssl.key-store=classpath:keystore.p12
server.ssl.key-store-password=password
server.ssl.key-alias=testCert
  1. 將產生的金鑰存放區檔案放在 資源 資料夾中。

步驟 4:執行程式碼範例

若要執行專案,請執行下列其中一個步驟:

  • 使用內嵌的 Spring Boot 伺服器直接從 IDE 執行它。
  • 使用 Maven將其封裝到 WAR 檔案,然後將它部署到 J2EE 容器解決方案,例如 Apache Tomcat
從 IDE 執行專案

若要從 IDE 執行 Web 應用程式,請選取 [執行],然後移至專案的首頁。 在此範例中,標準頁面 URL 為「https://localhost:8443.」

  1. 在首頁上,選取 [登入] 按鈕,將使用者重新導向至Microsoft Entra ID,並提示他們輸入認證。

  2. 驗證用戶之後,系統會將使用者重新導向至 https://localhost:8443/msal4jsample/secure/aad。 他們現在已登入,頁面會顯示用戶帳戶的相關信息。 範例 UI 有下列按鈕:

    • 登出:將目前使用者登出應用程式,並重導到首頁。
    • 顯示使用者資訊:取得 Microsoft Graph 的令牌,並使用包含令牌的要求呼叫 Microsoft Graph,以傳回登入使用者的基本資訊。
從 Tomcat 執行專案

如果您想要將 Web 範例部署到 Tomcat,請對原始程式碼進行幾項變更。

  1. 開啟 ms-identity-java-webapp/src/main/java/com.microsoft.azure.msalwebsample/MsalWebSampleApplication

    • 刪除所有原始程式碼,並將它取代為下列程式代碼:

       package com.microsoft.azure.msalwebsample;
      
       import org.springframework.boot.SpringApplication;
       import org.springframework.boot.autoconfigure.SpringBootApplication;
       import org.springframework.boot.builder.SpringApplicationBuilder;
       import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
      
       @SpringBootApplication
       public class MsalWebSampleApplication extends SpringBootServletInitializer {
      
        public static void main(String[] args) {
         SpringApplication.run(MsalWebSampleApplication.class, args);
        }
      
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
         return builder.sources(MsalWebSampleApplication.class);
        }
       }
      
  2. Tomcat 的預設 HTTP 埠為 8080,但您需要透過埠 8443 的 HTTPS 連線。 若要設定此設定:

    • 移至 tomcat/conf/server.xml

    • 搜尋 <connector> 標籤,然後將目前的接頭替換為這個接頭:

      <Connector
               protocol="org.apache.coyote.http11.Http11NioProtocol"
               port="8443" maxThreads="200"
               scheme="https" secure="true" SSLEnabled="true"
               keystoreFile="C:/Path/To/Keystore/File/keystore.p12" keystorePass="KeystorePassword"
               clientAuth="false" sslProtocol="TLS"/>
      
  3. 開啟 [命令提示字元] 視窗。 移至此範例的根資料夾(pom.xml 檔案所在的位置),然後執行 mvn package 來建置專案。

    • 此命令會在 /targets 目錄中產生 msal-web-sample-0.1.0.war 檔案。
    • 將此檔案重新命名為 msal4jsample.war
    • 使用 Tomcat 或任何其他 J2EE 容器解決方案部署 WAR 檔案。
      • 若要部署 msal4jsample.war 檔案,請將它複製到 Tomcat 安裝中的 /webapps/ 目錄,然後啟動 Tomcat 伺服器。
  4. 部署檔案之後,請使用瀏覽器前往 https://localhost:8443/msal4jsample

重要

本快速入門應用程式會使用客戶端密碼,將自己識別為機密用戶端。 因為客戶端密碼會新增為項目檔的純文本,因此基於安全性考慮,建議您在生產環境中使用應用程式之前,先使用憑證,而不是客戶端密碼。 如需如何使用憑證的詳細資訊,請參閱 憑證認證,以取得應用程式驗證

詳細資訊

範例的運作方式

顯示本快速入門所產生的範例應用程式運作方式的圖表。

取得 MSAL

適用於 Java 的 MSAL (MSAL4J) 是用來登入使用者和要求令牌的 Java 連結庫,用來存取受Microsoft身分識別平臺保護的 API。

使用 Maven 或 Gradle 將 MSAL4J 新增至您的應用程式,藉由對應用程式的 pom.xml (Maven) 或 build.gradle 檔案進行下列變更來管理相依性。

在 pom.xml中:

<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>msal4j</artifactId>
    <version>1.0.0</version>
</dependency>

在 build.gradle 中:

compile group: 'com.microsoft.azure', name: 'msal4j', version: '1.0.0'

初始化 MSAL

在您將使用 MSAL4J 的檔案開頭,新增下列程式碼來引入 MSAL for Java 的參考:

import com.microsoft.aad.msal4j.*;

幫助與支援

如果您需要協助、想要回報問題,或想要瞭解支援選項,請參閱 開發人員的說明和支援

後續步驟

如需更深入討論在 Microsoft 身份識別平台上建立讓使用者登入的 Web 應用程式,請參閱多段式案例系列: