شروع سریع Java

این راهنمای شروع سریع توضیح می‌دهد که چگونه یک برنامه خط فرمان ساده Java راه‌اندازی کنید که درخواست‌هایی را به YouTube Data API ارسال می‌کند. این شروع سریع درواقع نحوه ایجاد دو درخواست API را توضیح می‌دهد:

1. برای بازیابی اطلاعات درباره کانال YouTube GoogleDevelopers، از کلید API استفاده خواهید کرد که برنامه شما را شناسایی می‌کند.
2. از شناسه کارخواه OAuth 2.0 برای ارسال درخواست مجاز استفاده خواهید کرد که اطلاعات مربوط به کانال YouTube خودتان را بازیابی می‌کند.

توجه: به‌طور کلی، می‌توانید دستورالعمل‌های مثال اول را برای هر مورد استفاده‌ای که از کلید میانای برنامه‌سازی کاربردی استفاده می‌کند، یا دستورالعمل‌های مثال دوم را برای هر مورد استفاده‌ای که نیاز به مجوز بااستفاده از OAuth 2.0 دارد، دنبال کنید. برای نمونه‌های بیشتر، ابزار نمونه‌های کد و موارد استفاده را ببینید.

پیش‌نیازها

برای اجرای این شروع سریع، به موارد زیر نیاز دارید:

• ‫Java 1.7 یا بالاتر.
• Gradle نسخه ۲.۳ یا بالاتر.
• دسترسی به اینترنت و مرورگر وب.
• «حساب Google».

مرحله ۱: راه‌اندازی پروژه و اطلاعات کاربری

پروژه‌ای در کنسول Cloud ایجاد یا انتخاب کنید. تکالیف زیر را در Cloud Console برای پروژه‌تان تکمیل کنید:

1. در پانل کتابخانه، YouTube Data API v3 را جستجو کنید. روی فهرستگان آن میانای برنامه‌سازی کاربردی کلیک کنید و مطمئن شوید میانای برنامه‌سازی کاربردی برای پروژه‌تان فعال باشد.

2. در پانل اطلاعات اعتباری، دو اطلاعات اعتباری ایجاد کنید:

   1. ایجاد کلید میانای API از کلید میانای API برای ایجاد درخواست‌های میانای API که به مجوز کاربر نیاز ندارند استفاده خواهید کرد. برای مثال، برای بازیابی اطلاعات درباره یک کانال عمومی YouTube، نیازی به مجوز کاربر ندارید.

   2. ایجاد شناسه کارخواه OAuth 2.0 نوع برنامه را روی برنامه رایانه‌ای تنظیم کنید. باید از اطلاعات اعتباری OAuth 2.0 برای درخواست‌هایی که نیاز به مجوز کاربر دارند استفاده کنید. برای مثال، برای بازیابی اطلاعات مربوط به کانال YouTube کاربر اصالت‌سنجی‌شده فعلی، به مجوز کاربر نیاز دارید.

      فایل JSON حاوی اطلاعات کاربری OAuth 2.0 را بارگیری کنید. نام فایل باید شبیه client_secret_CLIENTID.json باشد، که در آن CLIENTID شناسه کاربر برای پروژه شما است.

مرحله ۲: آماده کردن پروژه

برای آماده کردن پروژه Gradle، مراحل زیر را تکمیل کنید:

1. در فهرست راهنمای کاری‌تان، فرمان‌های زیر را اجرا کنید تا ساختار پروژه جدیدی ایجاد شود:

   $ gradle init --type basic
   $ mkdir -p src/main/java src/main/resources
   

2. فایل JSON را که پس‌از ایجاد شناسه کارخواه OAuth 2.0 بارگیری کرده‌اید به دایرکتوری src/main/resources در زیر دایرکتوری کاری‌تان منتقل کنید و نام فایل را به client_secret.json تغییر دهید.

3. فایل build.gradle را در دایرکتوری کاری‌تان باز کنید و محتوای آن را با موارد زیر جایگزین کنید:

   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'ApiExample'
   sourceCompatibility = 1.7
   targetCompatibility = 1.7
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       compile 'com.google.api-client:google-api-client:1.23.0'
       compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
       compile 'com.google.apis:google-api-services-youtube:v3-revREVISION-CL_VERSION'
   }

4. در فایل build.gradle، باید متغیرهای REVISION و CL_VERSION را با دو مقدار از اسناد کتابخانه کارخواه برای YouTube Data API جایگزین کنید. نماگرفت زیر که اسناد YouTube Analytics API را نشان می‌دهد، محل نمایش دو متغیر را در صفحه نشان می‌دهد.

   

مرحله ۳: راه‌اندازی و اجرای نمونه

از ابزارک APIs Explorer در پانل کناری برای دریافت کد نمونه برای بازیابی اطلاعات درباره کانال YouTube GoogleDevelopers استفاده کنید. این درخواست از کلید میانای برنامه‌سازی کاربردی برای شناسایی برنامه شما استفاده می‌کند و به مجوز کاربر یا هیچ اجازه خاصی ازسوی کاربری که نمونه را اجرا می‌کند نیاز ندارد.

1. مستندات مربوط به روش API channels.list را باز کنید.

2. در آن صفحه، بخش «موارد استفاده رایج» حاوی جدولی است که چندین روش رایج استفاده از این متد را توضیح می‌دهد. اولین فهرستگان در جدول برای فهرست کردن نتایج براساس شناسه کانال است.

   روی نماد کد برای اولین فهرست کلیک کنید تا API Explorer تمام‌صفحه باز و پر شود.

   

3. سمت راست «کاوشگر میاناهای برنامه‌سازی کاربردی» تمام‌صفحه موارد زیر را نشان می‌دهد:

   1. در زیر سرصفحه پارامترهای درخواست، فهرستی از پارامترهایی وجود دارد که روش پشتیبانی می‌کند. مقادیر پارامتر part و id باید تنظیم شود. مقدار پارامتر id، UC_x5XG1OV2P6uZZ5FSM9Ttw، شناسه کانال YouTube مربوط به GoogleDevelopers است.

   2. در زیر پارامترها، بخشی به‌نام اعتبارنامه‌ها وجود دارد. منوِ کرکره‌ای در آن بخش باید مقدار کلید میانای برنامه‌سازی کاربردی را نمایش دهد. APIs Explorer به‌طور پیش‌فرض از اعتبارنامه‌های نمایشی استفاده می‌کند تا شروع کار آسان‌تر شود. اما برای اجرای نمونه به‌صورت محلی، از کلید میانای برنامه‌سازی کاربردی خودتان استفاده خواهید کرد.

      

4. سمت راست «کاوشگر میاناهای برنامه‌سازی کاربردی» تمام‌صفحه، برگه‌هایی با نمونه‌های کد به زبان‌های مختلف نشان می‌دهد. برگه Java را انتخاب کنید.

5. نمونه کد را کپی کنید و آن را در فایلی با نام src/main/java/ApiExample.java ذخیره کنید. همه نمونه‌ها از یک نام کلاس (ApiExample) استفاده می‌کنند تا برای اجرای نمونه‌های مختلف نیازی به اصلاح فایل build.gradle نداشته باشید.

6. در نمونه‌ای که بارگیری کردید، رشته YOUR_API_KEY را پیدا کنید و آن را با کلید میانای برنامه‌سازی کاربردی که در مرحله ۱ این راهنمای شروع سریع ایجاد کردید جایگزین کنید.

7. نمونه را از خط فرمان اجرا کنید. در دایرکتوری کاری‌تان، این دستور را اجرا کنید:

   gradle -q run

8. نمونه باید درخواست را اجرا کند و پاسخ را در STDOUT چاپ کند.

مرحله ۴: اجرای درخواست مجاز

در این مرحله، نمونه کدتان را اصلاح می‌کنید تا به‌جای بازیابی اطلاعات مربوط به کانال YouTube‏ GoogleDevelopers، اطلاعات مربوط به کانال YouTube شما را بازیابی کند. این درخواست به مجوز کاربر نیاز دارد.

1. به اسناد مربوط به روش channels.list میانای برنامه‌سازی کاربردی برگردید.

2. در بخش «موارد استفاده رایج»، روی نماد کد برای سومین فهرستگان در جدول کلیک کنید. مورد استفاده این است که روش list را برای «کانال من» فراخوانی کنید.

3. دوباره، در سمت راست «کاوشگر میاناهای برنامه‌سازی کاربردی» تمام‌صفحه، فهرستی از پارامترها را خواهید دید که پس‌از آن بخش اعتبارنامه‌ها قرار دارد. بااین‌حال، دو تغییر نسبت‌به نمونه‌ای که اطلاعات مربوط به کانال GoogleDevelopers را بازیابی کردید وجود دارد:

   1. در بخش پارامترها، به‌جای تنظیم مقدار پارامتر id، مقدار پارامتر mine باید روی true تنظیم شود. این دستور به سرور API می‌گوید اطلاعات مربوط به کانال کاربر اصالت‌سنجی‌شده فعلی را بازیابی کند.

   2. در بخش اطلاعات اعتباری، منوِ کرکره‌ای باید گزینه Google OAuth 2.0 را انتخاب کند.

      علاوه‌براین، اگر روی پیوند نمایش محدوده‌ها کلیک کنید، محدوده https://www.googleapis.com/auth/youtube.readonly باید علامت زده شود.

      

4. مانند مثال قبلی، برگه Java را انتخاب کنید، نمونه کد را کپی کنید و آن را در src/main/java/ApiExample.java ذخیره کنید.

5. نمونه را از خط فرمان اجرا کنید. در دایرکتوری کاری‌تان، این دستور را اجرا کنید:

   gradle -q run

6. نمونه باید تلاش کند پنجره یا برگه جدیدی در مرورگر پیش‌فرض شما باز کند. اگر این کار ناموفق بود، نشانی وب را از پایانه کپی کنید و آن را به‌صورت دستی در مرورگرتان باز کنید.

   اگر قبلاً به سیستم حساب Google خود وارد نشده باشید، از شما خواسته می‌شود به سیستم وارد شوید. اگر به سیستم چند حساب Google وارد شده باشید، از شما خواسته می‌شود یک حساب را برای استفاده در فرایند صدور مجوز انتخاب کنید.

7. روی دکمه کلیک کنید تا به برنامه‌تان اجازه دهید به دامنه‌های مشخص‌شده در نمونه کدتان دسترسی داشته باشد.

8. نمونه به‌طور خودکار ادامه خواهد یافت و می‌توانید زبانه مرورگر استفاده‌شده برای جریان اصالت‌سنجی را ببندید.

   پاسخ میانای برنامه‌سازی کاربردی باید دوباره در STDOUT چاپ شود.

مطالعه بیشتر

• مستندات راهنمای Google Developers Console
• مستندات کتابخانه کارخواه Google APIs برای Java
• مستندات YouTube Data API Javadoc
• اسناد مرجع YouTube Data API