1. ภาพรวม
Cloud Spanner คือ RDBMS ที่มีความพร้อมใช้งานสูง ปรับขนาดในแนวนอนได้ และมีหลายภูมิภาค Code Lab นี้จะใช้อินสแตนซ์ Cloud Spanner ที่เล็กที่สุด แต่โปรดอย่าลืมปิดเมื่อเสร็จสิ้น
สิ่งที่คุณจะได้เรียนรู้
- วิธีใช้ Cloud Spanner เพื่อบันทึกและเรียกข้อมูลด้วย Spring Boot
สิ่งที่คุณต้องมี
คุณจะใช้บทแนะนำนี้อย่างไร
คุณจะให้คะแนนประสบการณ์การใช้บริการ Google Cloud Platform เท่าใด
2. การตั้งค่าและข้อกำหนด
การตั้งค่าสภาพแวดล้อมแบบเรียนรู้ด้วยตนเอง
- ลงชื่อเข้าใช้ Cloud Console แล้วสร้างโปรเจ็กต์ใหม่หรือใช้โปรเจ็กต์ที่มีอยู่ซ้ำ (หากยังไม่มีบัญชี Gmail หรือ G Suite คุณต้องสร้างบัญชี)
โปรดจดจำรหัสโปรเจ็กต์ ซึ่งเป็นชื่อที่ไม่ซ้ำกันในโปรเจ็กต์ Google Cloud ทั้งหมด (ชื่อด้านบนมีผู้ใช้แล้วและจะใช้ไม่ได้ ขออภัย) ซึ่งจะเรียกว่า PROJECT_ID ในภายหลังใน Codelab นี้
- จากนั้นคุณจะต้องเปิดใช้การเรียกเก็บเงินใน Cloud Console เพื่อใช้ทรัพยากร Google Cloud
การทำตาม Codelab นี้ไม่ควรมีค่าใช้จ่ายมากนัก หรืออาจไม่มีเลย โปรดทำตามวิธีการในส่วน "การล้างข้อมูล" ซึ่งจะแนะนำวิธีปิดทรัพยากรเพื่อไม่ให้มีการเรียกเก็บเงินนอกเหนือจากบทแนะนำนี้ ผู้ใช้ Google Cloud รายใหม่มีสิทธิ์เข้าร่วมโปรแกรมช่วงทดลองใช้ฟรีมูลค่า$300 USD
เปิดใช้งาน Cloud Shell
- จาก Cloud Console ให้คลิกเปิดใช้งาน Cloud Shell
หากไม่เคยเริ่มใช้ Cloud Shell มาก่อน คุณจะเห็นหน้าจอระดับกลาง (ด้านล่าง) ที่อธิบายว่า Cloud Shell คืออะไร ในกรณีนี้ ให้คลิกต่อไป (และคุณจะไม่เห็นหน้าจอนี้อีก) หน้าจอแบบครั้งเดียวจะมีลักษณะดังนี้
การจัดสรรและเชื่อมต่อกับ Cloud Shell จะใช้เวลาไม่นาน
เครื่องเสมือนนี้มาพร้อมเครื่องมือพัฒนาซอฟต์แวร์ทั้งหมดที่คุณต้องการ โดยมีไดเรกทอรีหลักแบบถาวรขนาด 5 GB และทำงานใน Google Cloud ซึ่งช่วยเพิ่มประสิทธิภาพเครือข่ายและการตรวจสอบสิทธิ์ได้อย่างมาก คุณสามารถทำงานในโค้ดแล็บนี้ได้โดยใช้เพียงเบราว์เซอร์หรือ Chromebook
เมื่อเชื่อมต่อกับ Cloud Shell แล้ว คุณควรเห็นว่าคุณได้รับการตรวจสอบสิทธิ์แล้วและโปรเจ็กต์ได้รับการตั้งค่าเป็นรหัสโปรเจ็กต์ของคุณแล้ว
- เรียกใช้คำสั่งต่อไปนี้ใน Cloud Shell เพื่อยืนยันว่าคุณได้รับการตรวจสอบสิทธิ์แล้ว
gcloud auth list
เอาต์พุตของคำสั่ง
Credentialed Accounts
ACTIVE ACCOUNT
* <my_account>@<my_domain.com>
To set the active account, run:
$ gcloud config set account `ACCOUNT`
gcloud config list project
เอาต์พุตของคำสั่ง
[core] project = <PROJECT_ID>
หากไม่ได้ตั้งค่าไว้ คุณตั้งค่าได้ด้วยคำสั่งนี้
gcloud config set project <PROJECT_ID>
เอาต์พุตของคำสั่ง
Updated property [core/project].
3. เริ่มต้น Cloud Spanner
เปิดใช้ Cloud Spanner API โดยใช้ gcloud CLI
gcloud services enable spanner.googleapis.com
สร้างอินสแตนซ์ Cloud Spanner
gcloud spanner instances create spanner-instance \ --config=regional-us-central1 \ --nodes=1 --description="A Spanner Instance"
สร้างฐานข้อมูลภายในอินสแตนซ์
gcloud spanner databases create orders \ --instance=spanner-instance
สร้างไฟล์ schema.ddl เพื่ออธิบายสคีมาข้อมูล
cat << EOF > schema.ddl CREATE TABLE orders ( order_id STRING(36) NOT NULL, description STRING(255), creation_timestamp TIMESTAMP, ) PRIMARY KEY (order_id); CREATE TABLE order_items ( order_id STRING(36) NOT NULL, order_item_id STRING(36) NOT NULL, description STRING(255), quantity INT64, ) PRIMARY KEY (order_id, order_item_id), INTERLEAVE IN PARENT orders ON DELETE CASCADE; EOF
ใช้สคีมากับฐานข้อมูล Cloud Spanner โดยทำดังนี้
gcloud spanner databases ddl update orders \ --instance=spanner-instance \ --ddl="$(<schema.ddl)"
4. เริ่มต้นใช้งานแอปพลิเคชัน Java ของ Spring Boot ใหม่
จากสภาพแวดล้อม Cloud Shell ให้ใช้คำสั่งต่อไปนี้เพื่อเริ่มต้นและบูตแอปพลิเคชัน Spring Boot ใหม่
$ curl https://start.spring.io/starter.tgz \ -d packaging=jar \ -d dependencies=cloud-gcp,web,lombok \ -d baseDir=spanner-example \ -d type=maven-project \ -d bootVersion=3.2.6 | tar -xzvf - $ cd spanner-example
การดำเนินการนี้จะสร้างไดเรกทอรี spanner-example/ ใหม่พร้อมโปรเจ็กต์ Maven ใหม่ รวมถึง pom.xml ของ Maven, Maven Wrapper และจุดแรกเข้าของแอปพลิเคชัน
ในไฟล์ pom.xml ให้เพิ่ม Spring Data Cloud Spanner Starter
spanner-example/pom.xml
<project>
...
<dependencies>
...
<!-- Add Spring Cloud GCP Spanner Starter -->
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>spring-cloud-gcp-starter-data-spanner</artifactId>
</dependency>
...
</dependencies>
...
</project>
กำหนดค่าข้อมูลการเชื่อมต่อฐานข้อมูล Spanner ใน application.properties ดังนี้
spanner-example/src/main/resources/application.properties
spring.cloud.gcp.spanner.instance-id=spanner-instance spring.cloud.gcp.spanner.database=orders
ตรวจสอบว่าได้ตั้งค่า JAVA_HOME เป็นเวอร์ชันที่ถูกต้อง
export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64/
สร้างแอปใหม่เพื่อให้แน่ใจว่าการกำหนดค่า Maven ถูกต้อง
./mvnw package
5. สร้างเอนทิตี
การรองรับ Spring Data Spanner ของ Spring Cloud GCP ช่วยให้คุณสร้างออบเจ็กต์ Java และการแมป ORM ที่เป็นสำนวนกับตาราง Spanner ได้อย่างง่ายดายโดยใช้ Spring Data
ก่อนอื่น ให้สร้างคลาส Order Item
spanner-example/src/main/java/com/example/demo/OrderItem.java
package com.example.demo;
import com.google.cloud.spring.data.spanner.core.mapping.Column;
import com.google.cloud.spring.data.spanner.core.mapping.PrimaryKey;
import com.google.cloud.spring.data.spanner.core.mapping.Table;
@Table(name="order_items")
@Data
class OrderItem {
@PrimaryKey(keyOrder = 1)
@Column(name="order_id")
private String orderId;
@PrimaryKey(keyOrder = 2)
@Column(name="order_item_id")
private String orderItemId;
private String description;
private Long quantity;
}
สำหรับความสัมพันธ์ระดับบน/ย่อยใน Spanner คุณควรใช้คีย์หลักแบบรวม ในตัวอย่างนี้ คีย์ผสมคือ order_id และ order_item_id
จากนั้นสร้างคลาส Order ดังนี้
spanner-example/src/main/java/com/example/demo/Order.java
package com.example.demo;
import java.time.LocalDateTime;
import java.util.List;
import lombok.Data;
import com.google.cloud.spring.data.spanner.core.mapping.Column;
import com.google.cloud.spring.data.spanner.core.mapping.Interleaved;
import com.google.cloud.spring.data.spanner.core.mapping.PrimaryKey;
import com.google.cloud.spring.data.spanner.core.mapping.Table;
@Table(name="orders")
@Data
public class Order {
@PrimaryKey
@Column(name="order_id")
private String id;
private String description;
@Column(name="creation_timestamp")
private LocalDateTime timestamp;
@Interleaved
private List<OrderItem> items;
}
คลาสนี้ใช้คำอธิบายประกอบ @Interleaved เพื่อสร้างความสัมพันธ์แบบหนึ่งต่อหลายรายการกับรายการคำสั่งซื้อ
6. สร้างอินเทอร์เฟซ OrderRepository
สร้างOrderRepository คลาสที่มีเนื้อหาต่อไปนี้
spanner-example/src/main/java/com/example/demo/OrderRepository.java
package com.example.demo;
import com.google.cloud.spring.data.spanner.repository.SpannerRepository;
import org.springframework.stereotype.Repository;
@Repository
public interface OrderRepository extends SpannerRepository<Order, String> {
}
อินเทอร์เฟซขยาย SpannerRepository<Order, String> โดยที่ Order คือคลาสโดเมน และ String คือประเภทคีย์หลัก Spring Data จะให้สิทธิ์เข้าถึง CRUD ผ่านอินเทอร์เฟซนี้โดยอัตโนมัติ และคุณไม่จำเป็นต้องสร้างโค้ดเพิ่มเติม
7. สร้างตัวควบคุม REST สำหรับการดำเนินการพื้นฐาน
เปิดแอปพลิเคชันหลัก DemoApplication class แล้วแก้ไขให้มีลักษณะดังนี้
spanner-example/src/main/java/com/example/demo/DemoApplication.java
package com.example.demo;
import java.time.LocalDateTime;
import java.util.UUID;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.server.ResponseStatusException;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
@RestController
class OrderController {
private final OrderRepository orderRepository;
OrderController(OrderRepository orderRepository) {
this.orderRepository = orderRepository;
}
@GetMapping("/api/orders/{id}")
public Order getOrder(@PathVariable String id) {
return orderRepository.findById(id)
.orElseThrow(() -> new ResponseStatusException(HttpStatus.NOT_FOUND, id + " not found"));
}
@PostMapping("/api/orders")
public String createOrder(@RequestBody Order order) {
// Spanner currently does not auto generate IDs
// Generate UUID on new orders
order.setId(UUID.randomUUID().toString());
order.setTimestamp(LocalDateTime.now());
order.getItems().forEach(item -> {
// Assign parent ID, and also generate child ID
item.setOrderId(order.getId());
item.setOrderItemId(UUID.randomUUID().toString());
});
Order saved = orderRepository.save(order);
return saved.getId();
}
}
8. เรียกใช้แอปพลิเคชัน
สร้างและเรียกใช้แอปพลิเคชัน
./mvnw spring-boot:run
ซึ่งควรจะเริ่มทำงานอย่างถูกต้องและรับฟังบนพอร์ต 8080
คุณโพสต์บันทึกคำสั่งซื้อไปยังปลายทางได้โดยใช้
curl -H"Content-Type: application/json" -d'{"description": "My orders", "items": [{"description": "Android Phone", "quantity": "1"}]}' \
http://localhost:8080/api/orders
โดยควรตอบกลับด้วยUUIDของคำสั่งซื้อ
จากนั้นคุณจะเรียกข้อมูลคำสั่งซื้อด้วย UUID ได้
curl http://localhost:8080/api/orders/REPLACE_WITH_ORDER_UUID
หากต้องการดูวิธีจัดเก็บข้อมูลใน Cloud Spanner ให้ไปที่ Cloud Console แล้วไปที่ Spanner → อินสแตนซ์ Spanner → ฐานข้อมูลคำสั่งซื้อ → ตารางคำสั่งซื้อ → ข้อมูล
9. ล้างข้อมูล
หากต้องการล้างข้อมูล ให้ลบอินสแตนซ์ Spanner เพื่อไม่ให้มีการเรียกเก็บเงินอีก
gcloud spanner instances delete spanner-instance -q
10. ยินดีด้วย
ในโค้ดแล็บนี้ คุณได้สร้างแอปพลิเคชัน CLI แบบอินเทอร์แอกทีฟที่จัดเก็บและดึงข้อมูลจาก Cloud Spanner ได้แล้ว
ดูข้อมูลเพิ่มเติม
- Cloud Spanner: https://cloud.google.com/spanner/
- โปรเจ็กต์ Spring บน GCP: https://googlecloudplatform.github.io/spring-cloud-gcp/reference/html/
- ที่เก็บ Spring บน GCP ใน GitHub: https://github.com/spring-cloud/spring-cloud-gcp
- Java ใน Google Cloud Platform: https://cloud.google.com/java/
ใบอนุญาต
ผลงานนี้ได้รับอนุญาตภายใต้สัญญาอนุญาตครีเอทีฟคอมมอนส์สำหรับยอมรับสิทธิของผู้สร้าง (Creative Commons Attribution License) 2.0 แบบทั่วไป