詳解KeyProperty的使用

KeyProperty是Google App Engine中一種用於標識實體的唯一鍵的數據類型。使用KeyProperty可以極大地簡化數據實體之間的關聯，本文將從幾個方面詳細闡述KeyProperty的使用方法。

一、創建實體並設置KeyProperty屬性

在創建實體之前，需要先導入ndb庫中的KeyProperty。

from google.appengine.ext import ndb

class Student(ndb.Model):
    name = ndb.StringProperty()
    age = ndb.IntegerProperty()
    school = ndb.StringProperty()
    student_id = ndb.KeyProperty()

以上是一個名為Student的實體，其中student_id屬性為KeyProperty類型。接下來創建一個學生實體，並設置該實體的鍵。

def create_student():
    student_key = ndb.Key('School', 'Stanford', 'Student', '001')
    student = Student(key=student_key, name='Tom', age=20, school='Stanford')
    student.put()

在上述代碼中，我們首先創建了一個包含學校名及學生編號的Key。接下來創建一個學生實體，將已創建的Key對象指定為實體的鍵。最後調用put()方法存儲實體到Google Datastore。

二、查詢相關實體

根據實體的鍵值可以輕鬆查詢相關實體。

def query_student():
    student_key = ndb.Key('School', 'Stanford', 'Student', '001')
    student = student_key.get()
    print(student.name, student.age, student.school)

在這段代碼中，首先創建了一個包含學校名及學生編號的Key。然後我們使用get()方法，根據這個Key來查詢實體並輸出學生的相關信息。

三、實體之間的關聯

通過KeyProperty可以輕鬆地實現實體之間的關聯。下面是一個班級實體，其中students屬性為KeyProperty類型，表示當前班級的學生列表。

class Class(ndb.Model):
    name = ndb.StringProperty()
    classroom = ndb.StringProperty()
    students = ndb.KeyProperty(repeated=True)

接下來演示如何將學生實體與班級實體關聯：

def create_class():
    tom_key = ndb.Key('School', 'Stanford', 'Student', '001')
    john_key = ndb.Key('School', 'Stanford', 'Student', '002')
    student_keys = [tom_key, john_key]

    class_key = ndb.Key('School', 'Stanford', 'Class', 'Math')
    math_class = Class(key=class_key, name='Math Class', classroom='A201', students=student_keys)
    math_class.put()

在上述代碼中，我們定義了兩個學生實體的Key，然後將這兩個Key組成一個列表。最後，我們定義一個班級實體的Key，將其作為班級實體的鍵，並設置班級名稱、教室位置及學生列表。調用put()方法將班級實體存儲到Google Datastore中。

四、Key的高級用法：ancestor和namespace

除了id和name以外，Key還有兩個屬性：ancestor和namespace。通過這兩個屬性，可以將實體組織成一個樹形結構。

# 定義一個命名空間
ndb.get_context().namespace = 'MyNamespace'

# 定義一個學校實體
school_key = ndb.Key('School', 'Stanford')

# 定義學生實體並設置其父實體為學校實體
student_key = ndb.Key('Student', '001', parent=school_key)

# 定義班級實體並設置其父實體為學校實體
class_key = ndb.Key('Class', 'Math', parent=school_key)

# 定義一門課程實體並設置其父實體為班級實體
course_key = ndb.Key('Course', 'Computer Science', parent=class_key)

在這段代碼中，我們首先定義了一個命名空間。接下來，我們通過Key的parent屬性，依次定義了學校、學生、班級、課程等實體，形成了一個樹形結構。

五、刪除實體

使用KeyProperty可以簡便地刪除特定實體。

def delete_student():
    student_key = ndb.Key('School', 'Stanford', 'Student', '001')
    student_key.delete()

在這段代碼中，我們根據學生的Key對象進行刪除操作。

六、總結

本文詳細介紹了 KeyProperty 的使用方法，包括創建實體並設置KeyProperty屬性、查詢相關實體、實體之間的關聯、Key的高級用法，以及刪除實體等操作。KeyProperty 可以方便地實現實體之間的關聯，並且可以通過樹形結構體現實體的層次關係。