使用 Microsoft Graph 和僅限應用程式驗證建置 Java 應用程式
本教學課程會教導您如何建置使用 Microsoft Graph API 的 Java 控制台應用程式,以使用僅限應用程式的驗證來存取數據。 對於需要存取組織中所有用戶數據的背景服務或應用程式而言,僅限應用程式驗證是不錯的選擇。
注意
若要瞭解如何使用 Microsoft Graph 代表使用者存取數據,請參閱此 使用者 (委派) 驗證教學課程。
在本教學課程中,您將:
提示
除了遵循本教學課程,您可以下載或複製 GitHub 存放庫 ,並遵循自述檔中的指示來註冊應用程式並設定專案。
必要條件
開始本教學課程之前,您應該先在開發計算機上安裝 Java SE 開發工具包 (JDK) 和 Gradle 。
您也應該擁有具有全域管理員角色Microsoft公司或學校帳戶。 如果您沒有Microsoft 365 租使用者,您可能有資格透過 Microsoft 365 開發人員計劃;如需詳細資訊,請參閱 常見問題。 或者,您可以 註冊 1 個月的免費試用版,或購買Microsoft 365 方案。
注意
本教學課程是使用 OpenJDK 17.0.2 版和 Gradle 7.4.2 版所撰寫。 本指南中的步驟可能適用於其他版本,但尚未經過測試。
在入口網站中註冊應用程式
在此練習中,您將在 Azure Active Directory 中註冊新的應用程式,以啟用 僅限應用程式的驗證。 您可以使用 Microsoft Entra 系統管理中心或使用 Microsoft Graph PowerShell SDK 來註冊應用程式。
註冊應用程式以進行僅限應用程式驗證
在本節中,您將使用 用戶端認證流程註冊支援僅限應用程式驗證的應用程式。
開啟瀏覽器並流覽至 Microsoft Entra 系統管理中心 ,並使用全域系統管理員帳戶登入。
選Microsoft左側導覽中的 [Entra ID ],依序展開 [ 身分識別]、[ 應用程式],然後選取 [ 應用程式註冊]。
選取 [新增註冊]。 輸入應用程式名稱,例如
Graph App-Only Auth Tutorial
。將 [支持的帳戶類型] 設定為 [僅限此組織目錄中的帳戶]。
將 [重新導向 URI ] 保留空白。
選取 [登錄]。 在應用程式的 [ 概觀 ] 頁面上,複製應用程式 (用戶端) 標識 符和 目錄 (租使用者) 標識 符的值並加以儲存,您在下一個步驟中將需要這些值。
在 [管理] 底下,選取 [API 權限]。
選取其數據列中的省略號 (...) ,然後選取 [移除許可權],以移除 [設定的許可權] 下的默認 User.Read 許可權。
選 取 [新增許可權],然後 Microsoft圖形]。
選取 應用程式權限。
選 取 [User.Read.All],然後選取 [ 新增許可權]。
選 取 [授與系統管理員同意...],然後選取 [ 是 ] 以提供所選許可權的管理員同意。
選取 [管理] 底下的 [憑證和秘密],然後選取 [新增客戶端密碼]。
輸入描述,選擇持續時間,然後選取 [ 新增]。
從 [ 值 ] 資料行複製秘密,您在後續步驟中將需要它。
重要
此用戶端密碼永不再顯示,因此現在請您確認將其複製。
注意
請注意,與註冊用戶驗證時的步驟不同,在本節中,您已設定Microsoft應用程式註冊的 Graph 許可權。 這是因為僅限應用程式的驗證會使用客戶端 認證流程,這需要在應用程式註冊上設定許可權。 如需詳細資訊,請參閱 .default 範圍。
建立Java控制台應用程式
在本節中,您將建立基本的 Java 控制台應用程式。
在您要建立項目的目錄中, (CLI) 開啟命令行介面。 執行下列命令來建立新的 Gradle 專案。
gradle init --dsl groovy --test-framework junit --type java-application --project-name graphapponlytutorial --package graphapponlytutorial
建立項目之後,請執行下列命令以在 CLI 中執行應用程式,以確認其運作正常。
./gradlew --console plain run
如果可以運作,應用程式應該會輸出
Hello World.
。
安裝相依性
繼續之前,請新增一些您稍後將使用的額外相依性。
- 適用於 Java 的 Azure 身分識別用戶端連結庫 ,可驗證使用者並取得存取令牌。
- Microsoft Graph SDK for Java 呼叫 Microsoft Graph。
開啟 ./app/build.gradle。 更新 區
dependencies
段以新增這些相依性。dependencies { // Use JUnit test framework. testImplementation 'junit:junit:4.13.2' // This dependency is used by the application. implementation 'com.google.guava:guava:33.2.1-jre' implementation 'com.azure:azure-identity:1.13.0' implementation 'com.microsoft.graph:microsoft-graph:6.13.0' }
將下列內容新增至 ./app/build.gradle 的結尾。
run { standardInput = System.in }
下次建置專案時,Gradle 將會下載這些相依性。
載入應用程式設定
在本節中,您會將應用程式註冊的詳細數據新增至專案。
在 ./app/src/main/resources 目錄中建立名為 graphapponlytutorial 的新目錄。
在名為 oAuth.properties 的 ./app/src/main/resources/graphapponlytutorial 目錄中建立新檔案,然後在該檔案中新增下列文字。
app.clientId=YOUR_CLIENT_ID_HERE app.clientSecret=YOUR_CLIENT_SECRET_HERE app.tenantId=YOUR_TENANT_ID_HERE
根據下表更新值。
設定 值 app.clientId
應用程式註冊的用戶端識別碼 app.tenantId
貴組織的租用戶標識碼 app.clientSecret
客戶端密碼 重要
如果您使用 git 之類的原始檔控制,現在是從原始檔控制中排除 oAuth.properties 檔案的好時機,以避免不小心洩漏您的應用程式識別符。
設計應用程式
在本節中,您將建立簡單的控制台型功能表。
開啟 ./app/src/main/java/graphapponlytutorial/App.java ,然後新增下列
import
語句。package graphapponlytutorial; import java.io.IOException; import java.util.InputMismatchException; import java.util.Properties; import java.util.Scanner; import com.microsoft.graph.models.User;
以下列內容取代現有的
main
函數。public static void main(String[] args) { System.out.println("Java App-Only Graph Tutorial"); System.out.println(); final Properties oAuthProperties = new Properties(); try { oAuthProperties.load(App.class.getResourceAsStream("oAuth.properties")); } catch (IOException e) { System.out.println("Unable to read OAuth configuration. Make sure you have a properly formatted oAuth.properties file. See README for details."); return; } initializeGraph(oAuthProperties); Scanner input = new Scanner(System.in); int choice = -1; while (choice != 0) { System.out.println("Please choose one of the following options:"); System.out.println("0. Exit"); System.out.println("1. Display access token"); System.out.println("2. List users"); System.out.println("3. Make a Graph call"); try { choice = input.nextInt(); } catch (InputMismatchException ex) { // Skip over non-integer input } input.nextLine(); // Process user choice switch(choice) { case 0: // Exit the program System.out.println("Goodbye..."); break; case 1: // Display access token displayAccessToken(); break; case 2: // List users listUsers(); break; case 3: // Run any Graph code makeGraphCall(); break; default: System.out.println("Invalid choice"); } } input.close(); }
在文件尾新增下列佔位符方法。 您將在後續步驟中實作它們。
private static void initializeGraph(Properties properties) { // TODO } private static void displayAccessToken() { // TODO } private static void listUsers() { // TODO } private static void makeGraphCall() { // TODO }
這會實作基本功能表,並從命令行讀取用戶的選擇。
- 刪除 ./app/src/test/java/graphapponlytutorial/AppTest.java。
新增僅限應用程序驗證
在本節中,您會將僅限應用程式的驗證新增至應用程式。 這是取得必要的 OAuth 存取令牌以呼叫 Microsoft Graph 的必要專案。 在此步驟中,您會將 適用於 Java 的 Azure 身分識別用戶端連結庫 整合到應用程式中,並為 適用於 Java 的 Microsoft Graph SDK 設定驗證。
設定僅限應用程式驗證的 Graph 用戶端
在本節中, ClientSecretCredential
您將使用 類別,使用 用戶端認證流程來要求存取令牌。
在名為 Graph.java 的 ./app/src/main/java/graphapponlytutorial 目錄中 建立 新檔案,並將下列程序代碼新增至該檔案。
package graphapponlytutorial; import java.util.Properties; import com.azure.core.credential.AccessToken; import com.azure.core.credential.TokenRequestContext; import com.azure.identity.ClientSecretCredential; import com.azure.identity.ClientSecretCredentialBuilder; import com.microsoft.graph.models.UserCollectionResponse; import com.microsoft.graph.serviceclient.GraphServiceClient;
新增空的 Graph 類別定義。
public class Graph { }
將下列程式代碼新增至 Graph 類別。
private static Properties _properties; private static ClientSecretCredential _clientSecretCredential; private static GraphServiceClient _appClient; public static void initializeGraphForAppOnlyAuth(Properties properties) throws Exception { // Ensure properties isn't null if (properties == null) { throw new Exception("Properties cannot be null"); } _properties = properties; if (_clientSecretCredential == null) { final String clientId = _properties.getProperty("app.clientId"); final String tenantId = _properties.getProperty("app.tenantId"); final String clientSecret = _properties.getProperty("app.clientSecret"); _clientSecretCredential = new ClientSecretCredentialBuilder() .clientId(clientId) .tenantId(tenantId) .clientSecret(clientSecret) .build(); } if (_appClient == null) { _appClient = new GraphServiceClient(_clientSecretCredential, new String[] { "https://graph.microsoft.com/.default" }); } }
以下列內容取代 App.java 中的空白
initializeGraph
函式。private static void initializeGraph(Properties properties) { try { Graph.initializeGraphForAppOnlyAuth(properties); } catch (Exception e) { System.out.println("Error initializing Graph for user auth"); System.out.println(e.getMessage()); } }
此程式代碼會宣告兩個 ClientSecretCredential
私用屬性:對象和 GraphServiceClient
物件。 函 initializeGraphForAppOnlyAuth
式會建立 的新實例 ClientSecretCredential
,然後使用該實例來建立 的新實 GraphServiceClient
例。 每次透過 Microsoft Graph _appClient
進行 API 呼叫時,它都會使用提供的認證來取得存取令牌。
測試 ClientSecretCredential
接下來,新增程式代碼以從 ClientSecretCredential
取得存取令牌。
將下列函式新增至
Graph
類別。public static String getAppOnlyToken() throws Exception { // Ensure credential isn't null if (_clientSecretCredential == null) { throw new Exception("Graph has not been initialized for app-only auth"); } // Request the .default scope as required by app-only auth final String[] graphScopes = new String[] {"https://graph.microsoft.com/.default"}; final TokenRequestContext context = new TokenRequestContext(); context.addScopes(graphScopes); final AccessToken token = _clientSecretCredential.getToken(context).block(); return token.getToken(); }
以下列內容取代 App.java 中的空白
displayAccessToken
函式。private static void displayAccessToken() { try { final String accessToken = Graph.getAppOnlyToken(); System.out.println("Access token: " + accessToken); } catch (Exception e) { System.out.println("Error getting access token"); System.out.println(e.getMessage()); } }
建置並執行應用程式。 當系統提示您輸入選項時,請輸入
1
。 應用程式會顯示存取令牌。Java App-Only Graph Tutorial Please choose one of the following options: 0. Exit 1. Display access token 2. List users 3. Make a Graph call 1 App-only token: eyJ0eXAiOiJKV1QiLCJub25jZSI6IlVDTzRYOWtKYlNLVjVkRzJGenJqd2xvVUcwWS...
提示
僅供驗證和偵錯之用,您只能在 使用 Microsoft 的在線令牌剖析器https://jwt.ms,將公司或學校帳戶 (的使用者存取令牌譯碼) 。 如果您在呼叫 Microsoft Graph 時遇到令牌錯誤,這會很有用。 例如,確認
scp
令牌中的宣告包含預期的 Microsoft Graph 許可權範圍。
列出使用者
在本節中,您將新增使用僅限應用程式驗證列出 Azure Active Directory 中所有使用者的功能。
開 啟 Graph.java ,並將下列函式新增至 Graph 類別。
public static UserCollectionResponse getUsers() throws Exception { // Ensure client isn't null if (_appClient == null) { throw new Exception("Graph has not been initialized for app-only auth"); } return _appClient.users().get(requestConfig -> { requestConfig.queryParameters.select = new String[] { "displayName", "id", "mail" }; requestConfig.queryParameters.top = 25; requestConfig.queryParameters.orderby = new String[] { "displayName" }; }); }
以下列內容取代 App.java 中的空白
listUsers
函式。private static void listUsers() { try { final UserCollectionResponse users = Graph.getUsers(); // Output each user's details for (User user: users.getValue()) { System.out.println("User: " + user.getDisplayName()); System.out.println(" ID: " + user.getId()); System.out.println(" Email: " + user.getMail()); } final Boolean moreUsersAvailable = users.getOdataNextLink() != null; System.out.println("\nMore users available? " + moreUsersAvailable); } catch (Exception e) { System.out.println("Error getting users"); System.out.println(e.getMessage()); } }
執行應用程式、登入,然後選擇選項 4 來列出使用者。
Please choose one of the following options: 0. Exit 1. Display access token 2. List users 3. Make a Graph call 2 User: Adele Vance ID: 05fb57bf-2653-4396-846d-2f210a91d9cf Email: AdeleV@contoso.com User: Alex Wilber ID: a36fe267-a437-4d24-b39e-7344774d606c Email: AlexW@contoso.com User: Allan Deyoung ID: 54cebbaa-2c56-47ec-b878-c8ff309746b0 Email: AllanD@contoso.com User: Bianca Pisani ID: 9a7dcbd0-72f0-48a9-a9fa-03cd46641d49 Email: NO EMAIL User: Brian Johnson (TAILSPIN) ID: a8989e40-be57-4c2e-bf0b-7cdc471e9cc4 Email: BrianJ@contoso.com ... More users available? True
程式代碼說明
請考慮函式中的程序 getUsers
代碼。
存取集合
這個方法會傳回使用者的集合。 Microsoft Graph 中傳回集合的大部分 API 不會在單一回應中傳回所有可用的結果。 相反地,他們會使用 分頁 來傳回部分結果,同時提供方法讓用戶端要求下一個「頁面」。
默認頁面大小
使用分頁的 API 會實作預設頁面大小。 針對使用者,預設值為10。 用戶端可以使用 $top 查詢參數來要求更多 (或更少 ) 。 在 getUsers
中,這是使用 top
要求組態中的 屬性來完成。
注意
中 top
設定的值是上限,而不是明確的數位。 API 會傳回一些使用者 ,最多可達 指定的值。
取得後續頁面
如果伺服器上有更多可用的結果,集合回應會包含具有 @odata.nextLink
API URL 的屬性,以存取下一頁。 Java 用戶端連結庫會將這個 公開為 getOdataNextLink
集合響應物件上的 方法。 如果這個方法傳回非 Null,則會有更多可用的結果。
排序集合
函式會使用 orderBy
要求組態上的 屬性來要求依用戶顯示名稱排序的結果。 這會將 $orderby查詢參數 新增至 API 呼叫。
選擇性:新增您自己的程序代碼
在本節中,您會將自己的 Microsoft Graph 功能新增至應用程式。 這可能是來自 Microsoft Graph 檔 或 Graph 總管的代碼段,或您所建立的程式碼。 此區段為選擇性。
更新應用程式
開 啟 Graph.java ,並將下列函式新增至 Graph 類別。
public static void makeGraphCall() { // INSERT YOUR CODE HERE }
以下列內容取代 App.java 中的空白
MakeGraphCallAsync
函式。private static void makeGraphCall() { try { Graph.makeGraphCall(); } catch (Exception e) { System.out.println("Error making Graph call"); System.out.println(e.getMessage()); } }
選擇 API
在您想要嘗試Microsoft圖形中尋找 API。 例如, 建立事件 API。 您可以使用 API 檔中的其中一個範例,也可以在 Graph 總管中自定義 API 要求,並使用產生的代碼段。
設定許可權
請查看所選取 API 參考檔的 [許可權] 區段, 以查看支援哪些驗證方法。 例如,某些 API 不支援僅限應用程式或個人Microsoft帳戶。
- 若要在 API 支援使用者 (委派的) 驗證) 時,使用使用者驗證 (呼叫 API,請參閱 使用者 (委派的) 驗證 教學課程。
- 若要使用僅限應用程式的驗證來呼叫 API (如果 API 支援它) ,請在 Azure AD 系統管理中心新增必要的許可權範圍。
新增您的程序代碼
將您的程式代碼複製到 makeGraphCallAsync
Graph.java 中的函 式。 如果您要從檔案或 Graph 總管複製代碼段,請務必將 重新命名 GraphServiceClient
為 _appClient
。
恭喜!
您已完成 Java Microsoft Graph 教學課程。 既然您有一個可呼叫 Microsoft Graph 的工作應用程式,您可以實驗並新增新功能。
- 瞭解如何使用 使用者 (委派的) 驗證 搭配 Microsoft Graph Java SDK。
- 請造訪 Microsoft Graph 概觀 ,以查看您可以使用 Microsoft Graph 存取的所有數據。
Java 範例
在這個區段有遇到問題嗎? 如果有,請提供意見反應,好讓我們可以改善這個區段。