คู่มือเริ่มต้นใช้งาน Java ฉบับย่อ

คู่มือเริ่มต้นฉบับย่อนี้อธิบายวิธีตั้งค่าแอปพลิเคชันบรรทัดคำสั่ง Java อย่างง่ายที่ส่งคำขอไปยัง YouTube Data API โดยคู่มือเริ่มต้นฉบับย่อนี้จะอธิบายวิธีส่งคำขอ API 2 รายการ

  1. คุณจะใช้คีย์ API ซึ่งระบุแอปพลิเคชันของคุณเพื่อดึงข้อมูลเกี่ยวกับช่อง GoogleDevelopers บน YouTube
  2. คุณจะใช้รหัสไคลเอ็นต์ OAuth 2.0 เพื่อส่งคำขอ ที่ได้รับอนุญาต ซึ่งดึงข้อมูลเกี่ยวกับช่อง YouTube ของคุณเอง

ข้อกำหนดเบื้องต้น

หากต้องการเรียกใช้คู่มือเริ่มต้นฉบับย่อนี้ คุณจะต้องมีสิ่งต่อไปนี้

  • Java 1.7 ขึ้นไป
  • Gradle 2.3 ขึ้นไป.
  • การเข้าถึงอินเทอร์เน็ตและเว็บเบราว์เซอร์
  • บัญชี Google

ขั้นตอนที่ 1: ตั้งค่าโปรเจ็กต์และข้อมูลเข้าสู่ระบบ

สร้างหรือเลือกโปรเจ็กต์ในคอนโซล Cloud ทำตามงานต่อไปนี้ในคอนโซล Cloud สำหรับโปรเจ็กต์

  1. ในแผงไลบรารี ให้ ค้นหา YouTube Data API v3 คลิกรายการสำหรับ API นั้น แล้วตรวจสอบว่าได้เปิดใช้ API สำหรับโปรเจ็กต์แล้ว

  2. ในแผงข้อมูลเข้าสู่ระบบ ให้สร้างข้อมูลเข้าสู่ระบบ 2 รายการ

    1. สร้างคีย์ API คุณจะใช้คีย์ API เพื่อส่งคำขอ API ที่ไม่ต้องมีการให้สิทธิ์จากผู้ใช้ เช่น คุณไม่จำเป็นต้องมีการให้สิทธิ์จากผู้ใช้เพื่อดึงข้อมูลเกี่ยวกับช่อง YouTube สาธารณะ

    2. สร้างรหัสไคลเอ็นต์ OAuth 2.0 ตั้งค่าประเภทแอปพลิเคชันเป็น แอปบนเดสก์ท็อป คุณต้องใช้ข้อมูลเข้าสู่ระบบ OAuth 2.0 สำหรับคำขอที่ต้องมีการให้สิทธิ์จากผู้ใช้ เช่น คุณต้องมีการให้สิทธิ์จากผู้ใช้เพื่อดึงข้อมูลเกี่ยวกับช่อง YouTube ของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วในปัจจุบัน

      ดาวน์โหลดไฟล์ JSON ที่มีข้อมูลเข้าสู่ระบบ OAuth 2.0 ไฟล์จะมีชื่อ เช่น client_secret_CLIENTID.json โดยที่ CLIENTID คือรหัสไคลเอ็นต์ของโปรเจ็กต์

ขั้นตอนที่ 2: เตรียมโปรเจ็กต์

ทำตามขั้นตอนต่อไปนี้เพื่อเตรียมโปรเจ็กต์ 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 ด้วยค่า 2 ค่าจาก เอกสารประกอบ ของไลบรารีของไคลเอ็นต์ สำหรับ YouTube Data API ภาพหน้าจอด้านล่างซึ่งแสดงเอกสารประกอบสำหรับ YouTube Analytics API จะแสดงตำแหน่งที่ตัวแปร 2 ตัวปรากฏในหน้า

    ภาพหน้าจอของการอ้างอิง JavaDoc ที่แสดงวิธีค้นหามูลค่าของตัวแปร "REVISION" และ "CL_VERSION"

ขั้นตอนที่ 3: ตั้งค่าและเรียกใช้ตัวอย่าง

ใช้วิดเจ็ต APIs Explorer ในแผงด้านข้างเพื่อรับโค้ดตัวอย่างสำหรับการดึงข้อมูลเกี่ยวกับช่อง GoogleDevelopers บน YouTube คำขอนี้ใช้คีย์ API เพื่อระบุแอปพลิเคชันของคุณ และไม่จำเป็นต้องมีการให้สิทธิ์จากผู้ใช้หรือสิทธิ์พิเศษใดๆ จากผู้ใช้ที่เรียกใช้ตัวอย่าง

  1. เปิดเอกสารประกอบสำหรับเมธอด channels.list ของ API

  2. ในหน้านั้น ส่วน "Use Case ที่พบบ่อย" จะมีตารางที่อธิบายวิธีที่พบบ่อยหลายวิธีในการใช้เมธอด รายการแรกในตารางคือการแสดงผลลัพธ์ตามรหัสช่อง

    คลิกสัญลักษณ์โค้ดสำหรับรายการแรกเพื่อเปิดและป้อนข้อมูลในโปรแกรมสำรวจ API แบบเต็มหน้าจอ

    รูปภาพที่ระบุตำแหน่งของลิงก์สัญลักษณ์โค้ดใน ตารางที่แสดงกรณีการใช้งานสำหรับเอกสารประกอบ channels.list ข้อความแสดงแทน สำหรับรูปภาพนั้นจะระบุรูปภาพเป็นสัญลักษณ์โค้ดและระบุ กรณีการใช้งานที่เชื่อมโยงกับลิงก์นั้น

  3. ด้านซ้ายของโปรแกรมสำรวจ API แบบเต็มหน้าจอจะแสดงสิ่งต่อไปนี้

    1. ใต้ส่วนหัวพารามิเตอร์คำขอ จะมีรายการพารามิเตอร์ที่เมธอดรองรับ คุณควรตั้งค่าพารามิเตอร์ part และ id ค่าพารามิเตอร์ id ซึ่งก็คือ UC_x5XG1OV2P6uZZ5FSM9Ttw เป็นรหัสของช่อง GoogleDevelopers บน YouTube

    2. ใต้พารามิเตอร์จะมีส่วนที่ชื่อว่าข้อมูลเข้าสู่ระบบ เมนูแบบเลื่อนลงในส่วนนั้นควรแสดงค่าคีย์ API โดยค่าเริ่มต้น โปรแกรมสำรวจ API จะใช้ข้อมูลเข้าสู่ระบบตัวอย่างเพื่อให้เริ่มต้นใช้งานได้ง่ายขึ้น แต่คุณจะใช้คีย์ API ของคุณเองเพื่อเรียกใช้ตัวอย่างในเครื่อง

      รูปภาพที่แสดง "ข้อมูลเข้าสู่ระบบ" ในโปรแกรมสำรวจ API แบบเต็มหน้าจอ และเมนูแบบเลื่อนลงที่เลือกตัวเลือก "คีย์ API" ไว้

  4. ด้านขวาของโปรแกรมสำรวจ API แบบเต็มหน้าจอจะแสดงแท็บที่มีตัวอย่างโค้ดในภาษาต่างๆ เลือกแท็บ Java

  5. คัดลอกตัวอย่างโค้ดแล้วบันทึกลงในไฟล์ชื่อ src/main/java/ApiExample.java ทุกตัวอย่างจะใช้ชื่อคลาสเดียวกัน (ApiExample) เพื่อให้คุณไม่ต้องแก้ไขไฟล์ build.gradle เพื่อเรียกใช้ตัวอย่างต่างๆ

  6. ในตัวอย่างที่ดาวน์โหลด ให้ค้นหาสตริง YOUR_API_KEY แล้วแทนที่ด้วยคีย์ API ที่คุณสร้างขึ้นในขั้นตอนที่ 1 ของคู่มือเริ่มต้นฉบับย่อนี้

  7. เรียกใช้ตัวอย่างจากบรรทัดคำสั่ง ในไดเรกทอรีที่ทำงานอยู่ ให้เรียกใช้คำสั่งต่อไปนี้

    gradle -q run

  8. ตัวอย่างควรดำเนินการคำขอและพิมพ์การตอบกลับไปยัง STDOUT

ขั้นตอนที่ 4: เรียกใช้คำขอที่ได้รับอนุญาต

ในขั้นตอนนี้ คุณจะแก้ไขตัวอย่างโค้ดเพื่อให้ดึงข้อมูลเกี่ยวกับช่อง YouTube ของคุณ แทนที่จะดึงข้อมูลเกี่ยวกับช่อง GoogleDevelopers บน YouTube คำขอนี้ต้องมีการให้สิทธิ์จากผู้ใช้

  1. กลับไปที่เอกสารประกอบสำหรับเมธอด channels.list ของ API

  2. ในส่วน "Use Case ที่พบบ่อย" ให้คลิกสัญลักษณ์โค้ดสำหรับรายการที่ 3 ในตาราง Use Case นั้นคือการเรียกใช้เมธอด list สำหรับ "ช่องของฉัน"

  3. อีกครั้งที่ด้านซ้ายของโปรแกรมสำรวจ API แบบเต็มหน้าจอ คุณจะเห็นรายการพารามิเตอร์ตามด้วยส่วนข้อมูลเข้าสู่ระบบ อย่างไรก็ตาม จะมีการเปลี่ยนแปลง 2 อย่างจากตัวอย่างที่คุณดึงข้อมูลเกี่ยวกับช่อง GoogleDevelopers

    1. ในส่วนพารามิเตอร์ ค่าพารามิเตอร์ id ไม่ควรตั้งค่า แต่ค่าพารามิเตอร์ mine ควรตั้งค่าเป็น true ซึ่งจะสั่งให้เซิร์ฟเวอร์ API ดึงข้อมูลเกี่ยวกับช่องของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วในปัจจุบัน

    2. ในส่วนข้อมูลเข้าสู่ระบบ เมนูแบบเลื่อนลงควรเลือกตัวเลือกสำหรับ Google OAuth 2.0

      นอกจากนี้ หากคุณคลิกลิงก์แสดงขอบเขต ขอบเขต https://www.googleapis.com/auth/youtube.readonly ควรเลือกไว้

      รูปภาพที่แสดงขอบเขตในโปรแกรมสำรวจ API แบบเต็มหน้าจอและ ตัวเลือกในการใช้ข้อมูลเข้าสู่ระบบ "Google OAuth 2.0" ที่เลือก

  4. เช่นเดียวกับตัวอย่างก่อนหน้า ให้เลือกแท็บ Java คัดลอกตัวอย่างโค้ด แล้วบันทึกลงใน src/main/java/ApiExample.java

  5. เรียกใช้ตัวอย่างจากบรรทัดคำสั่ง ในไดเรกทอรีที่ทำงานอยู่ ให้เรียกใช้คำสั่งต่อไปนี้

    gradle -q run

  6. ตัวอย่างควรพยายามเปิดหน้าต่างหรือแท็บใหม่ในเบราว์เซอร์เริ่มต้น หากดำเนินการไม่สำเร็จ ให้คัดลอก URL จากเทอร์มินัลแล้วเปิด URL นั้นในเบราว์เซอร์ด้วยตนเอง

    หากคุณยังไม่ได้เข้าสู่ระบบบัญชี Google ระบบจะแจ้งให้คุณเข้าสู่ระบบ หากคุณเข้าสู่ระบบบัญชี Google หลายบัญชี ระบบจะขอให้คุณเลือกบัญชีที่จะใช้ในการให้สิทธิ์

  7. คลิกปุ่มเพื่อให้สิทธิ์แอปพลิเคชันเข้าถึงขอบเขตที่ระบุไว้ในตัวอย่างโค้ด

  8. ตัวอย่างจะดำเนินการต่อโดยอัตโนมัติ และคุณสามารถปิดแท็บเบราว์เซอร์ที่ใช้สำหรับขั้นตอนการให้สิทธิ์ได้

    การตอบกลับจาก API ควรพิมพ์ไปยัง STDOUT อีกครั้ง

อ่านเพิ่มเติม