正在儲存資料

本文將介紹四種寫入 Firebase Realtime Database 資料的方法：設定、更新、推送和交易支援。

省用資料的方式

set	將資料寫入或取代至已定義的路徑，例如 messages/users/<username>
update	更新已定義路徑的部分金鑰，而不會取代所有資料
推送	新增至資料庫中的資料清單。每次將新節點推送至清單時，資料庫都會產生專屬的鍵，例如 messages/users/<unique-user-id>/<username>
交易	處理可能因並行更新而損毀的複雜資料時，請使用交易

儲存資料

基本資料庫寫入作業是一種作業，可將新資料儲存至指定的資料庫參照，取代該路徑上的任何現有資料。為了瞭解 set，我們將建構一個簡單的部落格應用程式。應用程式的資料會儲存在這個資料庫參照中：

Java

final FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference ref = database.getReference("server/saving-data/fireblog");

Node.js

// Import Admin SDK
const { getDatabase } = require('firebase-admin/database');

// Get a database reference to our blog
const db = getDatabase();
const ref = db.ref('server/saving-data/fireblog');

Python

# Import database module.
from firebase_admin import db

# Get a database reference to our blog.
ref = db.reference('server/saving-data/fireblog')

Go

// Create a database client from App.
client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// Get a database reference to our blog.
ref := client.NewRef("server/saving-data/fireblog")

首先，我們來儲存一些使用者資料。我們會使用每位使用者的專屬使用者名稱儲存資料，並儲存他們的全名和出生日期。由於每位使用者都有專屬的使用者名稱，因此您已擁有鍵，不必再建立鍵，因此建議在此處使用 set 方法，而非 push 方法。

首先，請建立資料庫參照使用者資料。接著，使用 set() / setValue() 將使用者物件連同使用者名稱、全名和生日儲存至資料庫。您可以傳遞字串、數字、布林值、null、陣列或任何 JSON 物件。傳遞 null 會移除指定位置的資料。在這種情況下，您會傳遞物件：

Java

public static class User {

  public String date_of_birth;
  public String full_name;
  public String nickname;

  public User(String dateOfBirth, String fullName) {
    // ...
  }

  public User(String dateOfBirth, String fullName, String nickname) {
    // ...
  }

}

DatabaseReference usersRef = ref.child("users");

Map<String, User> users = new HashMap<>();
users.put("alanisawesome", new User("June 23, 1912", "Alan Turing"));
users.put("gracehop", new User("December 9, 1906", "Grace Hopper"));

usersRef.setValueAsync(users);

Node.js

const usersRef = ref.child('users');
usersRef.set({
  alanisawesome: {
    date_of_birth: 'June 23, 1912',
    full_name: 'Alan Turing'
  },
  gracehop: {
    date_of_birth: 'December 9, 1906',
    full_name: 'Grace Hopper'
  }
});

Python

users_ref = ref.child('users')
users_ref.set({
    'alanisawesome': {
        'date_of_birth': 'June 23, 1912',
        'full_name': 'Alan Turing'
    },
    'gracehop': {
        'date_of_birth': 'December 9, 1906',
        'full_name': 'Grace Hopper'
    }
})

Go

// User is a json-serializable type.
type User struct {
	DateOfBirth string `json:"date_of_birth,omitempty"`
	FullName    string `json:"full_name,omitempty"`
	Nickname    string `json:"nickname,omitempty"`
}

usersRef := ref.Child("users")
err := usersRef.Set(ctx, map[string]*User{
	"alanisawesome": {
		DateOfBirth: "June 23, 1912",
		FullName:    "Alan Turing",
	},
	"gracehop": {
		DateOfBirth: "December 9, 1906",
		FullName:    "Grace Hopper",
	},
})
if err != nil {
	log.Fatalln("Error setting value:", err)
}

將 JSON 物件儲存至資料庫時，系統會以巢狀方式自動將物件屬性對應至資料庫子項位置。現在，如果您前往 https://docs-examples.firebaseio.com/server/saving-data/fireblog/users/alanisawesome/full_name 這個網址，就會看到「Alan Turing」這個值。您也可以直接將資料儲存到子位置：

Java

usersRef.child("alanisawesome").setValueAsync(new User("June 23, 1912", "Alan Turing"));
usersRef.child("gracehop").setValueAsync(new User("December 9, 1906", "Grace Hopper"));

Node.js

const usersRef = ref.child('users');
usersRef.child('alanisawesome').set({
  date_of_birth: 'June 23, 1912',
  full_name: 'Alan Turing'
});
usersRef.child('gracehop').set({
  date_of_birth: 'December 9, 1906',
  full_name: 'Grace Hopper'
});

Python

users_ref.child('alanisawesome').set({
    'date_of_birth': 'June 23, 1912',
    'full_name': 'Alan Turing'
})
users_ref.child('gracehop').set({
    'date_of_birth': 'December 9, 1906',
    'full_name': 'Grace Hopper'
})

Go

if err := usersRef.Child("alanisawesome").Set(ctx, &User{
	DateOfBirth: "June 23, 1912",
	FullName:    "Alan Turing",
}); err != nil {
	log.Fatalln("Error setting value:", err)
}

if err := usersRef.Child("gracehop").Set(ctx, &User{
	DateOfBirth: "December 9, 1906",
	FullName:    "Grace Hopper",
}); err != nil {
	log.Fatalln("Error setting value:", err)
}

上述兩個範例 - 同時將兩個值寫入物件，並將兩個值分別寫入子位置 - 都會將相同的資料儲存到資料庫：

{
  "users": {
    "alanisawesome": {
      "date_of_birth": "June 23, 1912",
      "full_name": "Alan Turing"
    },
    "gracehop": {
      "date_of_birth": "December 9, 1906",
      "full_name": "Grace Hopper"
    }
  }
}

第一個範例只會在監控資料的用戶端上觸發一個事件，而第二個範例則會觸發兩個事件。請注意，如果 usersRef 中已有資料，第一個方法會覆寫資料，但第二個方法只會修改各個子節點的值，而不會變更 usersRef 的其他子節點。

設定值會覆寫指定位置的資料，包括任何子節點。

更新儲存資料

如果您想同時寫入資料庫位置的多個子項，但不覆寫其他子項節點，可以使用更新方法，如下所示：

Java

DatabaseReference hopperRef = usersRef.child("gracehop");
Map<String, Object> hopperUpdates = new HashMap<>();
hopperUpdates.put("nickname", "Amazing Grace");

hopperRef.updateChildrenAsync(hopperUpdates);

Node.js

const usersRef = ref.child('users');
const hopperRef = usersRef.child('gracehop');
hopperRef.update({
  'nickname': 'Amazing Grace'
});

Python

hopper_ref = users_ref.child('gracehop')
hopper_ref.update({
    'nickname': 'Amazing Grace'
})

Go

hopperRef := usersRef.Child("gracehop")
if err := hopperRef.Update(ctx, map[string]interface{}{
	"nickname": "Amazing Grace",
}); err != nil {
	log.Fatalln("Error updating child:", err)
}

這麼做會更新 Grace 的資料，加入她的暱稱。如果您在此處使用 set 而非 update，系統會從 hopperRef 中刪除 full_name 和 date_of_birth。

Firebase Realtime Database 也支援多路更新。這表示更新現在可以同時更新資料庫中多個位置的值，這項強大的功能可協助您將資料去規格化。使用多路徑更新功能，您可以同時為 Grace 和 Alan 新增暱稱：

Java

Map<String, Object> userUpdates = new HashMap<>();
userUpdates.put("alanisawesome/nickname", "Alan The Machine");
userUpdates.put("gracehop/nickname", "Amazing Grace");

usersRef.updateChildrenAsync(userUpdates);

Node.js

const usersRef = ref.child('users');
usersRef.update({
  'alanisawesome/nickname': 'Alan The Machine',
  'gracehop/nickname': 'Amazing Grace'
});

Python

users_ref.update({
    'alanisawesome/nickname': 'Alan The Machine',
    'gracehop/nickname': 'Amazing Grace'
})

Go

if err := usersRef.Update(ctx, map[string]interface{}{
	"alanisawesome/nickname": "Alan The Machine",
	"gracehop/nickname":      "Amazing Grace",
}); err != nil {
	log.Fatalln("Error updating children:", err)
}

這次更新後，Alan 和 Grace 都已新增暱稱：

{
  "users": {
    "alanisawesome": {
      "date_of_birth": "June 23, 1912",
      "full_name": "Alan Turing",
      "nickname": "Alan The Machine"
    },
    "gracehop": {
      "date_of_birth": "December 9, 1906",
      "full_name": "Grace Hopper",
      "nickname": "Amazing Grace"
    }
  }
}

請注意，如果您嘗試透過寫入包含路徑的物件來更新物件，會導致不同的行為。讓我們看看如果您改用這種方式更新 Grace 和 Alan 會發生什麼事：

Java

Map<String, Object> userNicknameUpdates = new HashMap<>();
userNicknameUpdates.put("alanisawesome", new User(null, null, "Alan The Machine"));
userNicknameUpdates.put("gracehop", new User(null, null, "Amazing Grace"));

usersRef.updateChildrenAsync(userNicknameUpdates);

Node.js

const usersRef = ref.child('users');
usersRef.update({
  'alanisawesome': {
    'nickname': 'Alan The Machine'
  },
  'gracehop': {
    'nickname': 'Amazing Grace'
  }
});

Python

users_ref.update({
    'alanisawesome': {
        'nickname': 'Alan The Machine'
    },
    'gracehop': {
        'nickname': 'Amazing Grace'
    }
})

Go

if err := usersRef.Update(ctx, map[string]interface{}{
	"alanisawesome": &User{Nickname: "Alan The Machine"},
	"gracehop":      &User{Nickname: "Amazing Grace"},
}); err != nil {
	log.Fatalln("Error updating children:", err)
}

這會導致不同的行為，也就是覆寫整個 /users 節點：

{
  "users": {
    "alanisawesome": {
      "nickname": "Alan The Machine"
    },
    "gracehop": {
      "nickname": "Amazing Grace"
    }
  }
}

更新巢狀資料

假設有一個 alanisawesome 等單一鍵路徑，系統只會更新第一個子項層級的資料，而傳入第一個子項層級以外的任何資料都會視為集合運算。多路徑行為可讓您使用較長的路徑 (例如 alanisawesome/nickname)，而不會覆寫資料。這就是第一個範例與第二個範例的差異所在。

新增完成回呼

在 Node.js 和 Java Admin SDK 中，如果您想知道資料何時已提交，可以新增完成回呼。這些 SDK 中的 set 和 update 方法都會使用選用的完成回呼，在寫入作業已提交至資料庫時呼叫。如果呼叫因某些原因而失敗，回呼會傳遞錯誤物件，指出發生失敗的原因。在 Python 和 Go Admin SDK 中，所有寫入方法都會阻斷。也就是說，寫入方法不會傳回，直到寫入作業已提交至資料庫為止。

Java

DatabaseReference dataRef = ref.child("data");
dataRef.setValue("I'm writing data", new DatabaseReference.CompletionListener() {
  @Override
  public void onComplete(DatabaseError databaseError, DatabaseReference databaseReference) {
    if (databaseError != null) {
      System.out.println("Data could not be saved " + databaseError.getMessage());
    } else {
      System.out.println("Data saved successfully.");
    }
  }
});

Node.js

dataRef.set('I\'m writing data', (error) => {
  if (error) {
    console.log('Data could not be saved.' + error);
  } else {
    console.log('Data saved successfully.');
  }
});

儲存資料清單

建立資料清單時，請務必考量到大多數應用程式的多使用者特性，並據此調整清單結構。延續上述範例，我們來為應用程式新增網誌文章。您可能會直覺地使用集合，以自動遞增整數索引儲存子項，例如以下範例：

// NOT RECOMMENDED - use push() instead!
{
  "posts": {
    "0": {
      "author": "gracehop",
      "title": "Announcing COBOL, a New Programming Language"
    },
    "1": {
      "author": "alanisawesome",
      "title": "The Turing Machine"
    }
  }
}

推送與交易

使用資料清單時，push() 會確保使用不重複的時間順序鍵。您可能會想改用交易來產生自己的金鑰，但推送會是更好的選擇。交易速度較慢且更複雜。需要與伺服器進行一或多個往返傳輸。由用戶端 `push()` 產生的金鑰可在離線時運作，並針對效能進行最佳化。

如果使用者新增貼文，系統會將其儲存為 /posts/2。如果只有一位作者新增貼文，這麼做就沒問題，但在協作式網誌應用程式中，許多使用者可能會同時新增貼文。如果兩位作者同時寫入 /posts/2，則其中一個作者的文章會遭到刪除。

為解決這個問題，Firebase 客戶端會提供 push() 函式，為每個新子項產生專屬的鍵值。透過使用不重複的子項鍵，多個用戶端可以同時將子項新增至相同位置，而不必擔心寫入衝突。

Java

public static class Post {

  public String author;
  public String title;

  public Post(String author, String title) {
    // ...
  }

}

DatabaseReference postsRef = ref.child("posts");

DatabaseReference newPostRef = postsRef.push();
newPostRef.setValueAsync(new Post("gracehop", "Announcing COBOL, a New Programming Language"));

// We can also chain the two calls together
postsRef.push().setValueAsync(new Post("alanisawesome", "The Turing Machine"));

Node.js

const newPostRef = postsRef.push();
newPostRef.set({
  author: 'gracehop',
  title: 'Announcing COBOL, a New Programming Language'
});

// we can also chain the two calls together
postsRef.push().set({
  author: 'alanisawesome',
  title: 'The Turing Machine'
});

Python

posts_ref = ref.child('posts')

new_post_ref = posts_ref.push()
new_post_ref.set({
    'author': 'gracehop',
    'title': 'Announcing COBOL, a New Programming Language'
})

# We can also chain the two calls together
posts_ref.push().set({
    'author': 'alanisawesome',
    'title': 'The Turing Machine'
})

Go

// Post is a json-serializable type.
type Post struct {
	Author string `json:"author,omitempty"`
	Title  string `json:"title,omitempty"`
}

postsRef := ref.Child("posts")

newPostRef, err := postsRef.Push(ctx, nil)
if err != nil {
	log.Fatalln("Error pushing child node:", err)
}

if err := newPostRef.Set(ctx, &Post{
	Author: "gracehop",
	Title:  "Announcing COBOL, a New Programming Language",
}); err != nil {
	log.Fatalln("Error setting value:", err)
}

// We can also chain the two calls together
if _, err := postsRef.Push(ctx, &Post{
	Author: "alanisawesome",
	Title:  "The Turing Machine",
}); err != nil {
	log.Fatalln("Error pushing child node:", err)
}

不重複鍵會根據時間戳記，因此清單項目會自動依時間順序排序。由於 Firebase 會為每篇網誌文章產生專屬索引鍵，因此如果有多位使用者同時新增文章，就不會發生寫入衝突。資料庫資料現在會如下所示：

{
  "posts": {
    "-JRHTHaIs-jNPLXOQivY": {
      "author": "gracehop",
      "title": "Announcing COBOL, a New Programming Language"
    },
    "-JRHTHaKuITFIhnj02kE": {
      "author": "alanisawesome",
      "title": "The Turing Machine"
    }
  }
}

在 JavaScript、Python 和 Go 中，呼叫 push() 然後立即呼叫 set() 的模式非常常見，因此 Firebase SDK 可讓您結合這兩種模式，方法是將要設定的資料直接傳遞至 push()，如下所示：

Java

// No Java equivalent

Node.js

// This is equivalent to the calls to push().set(...) above
postsRef.push({
  author: 'gracehop',
  title: 'Announcing COBOL, a New Programming Language'
});;

Python

# This is equivalent to the calls to push().set(...) above
posts_ref.push({
    'author': 'gracehop',
    'title': 'Announcing COBOL, a New Programming Language'
})

Go

if _, err := postsRef.Push(ctx, &Post{
	Author: "gracehop",
	Title:  "Announcing COBOL, a New Programming Language",
}); err != nil {
	log.Fatalln("Error pushing child node:", err)
}

取得由 push() 產生的專屬鍵

呼叫 push() 會傳回新資料路徑的參照，您可以使用該參照取得索引鍵或將資料設為該索引鍵。下列程式碼會產生與上述範例相同的資料，但現在我們可以存取已產生的專屬金鑰：

Java

// Generate a reference to a new location and add some data using push()
DatabaseReference pushedPostRef = postsRef.push();

// Get the unique ID generated by a push()
String postId = pushedPostRef.getKey();

Node.js

// Generate a reference to a new location and add some data using push()
const newPostRef = postsRef.push();

// Get the unique key generated by push()
const postId = newPostRef.key;

Python

# Generate a reference to a new location and add some data using push()
new_post_ref = posts_ref.push()

# Get the unique key generated by push()
post_id = new_post_ref.key

Go

// Generate a reference to a new location and add some data using Push()
newPostRef, err := postsRef.Push(ctx, nil)
if err != nil {
	log.Fatalln("Error pushing child node:", err)
}

// Get the unique key generated by Push()
postID := newPostRef.Key

如您所見，您可以從 push() 參照取得不重複鍵的值。

在下一節「擷取資料」中，我們將說明如何從 Firebase 資料庫讀取這類資料。

儲存交易資料

當您處理可能因並行修改而損毀的複雜資料 (例如遞增計數器) 時，SDK 會提供交易作業。

在 Java 和 Node.js 中，您可以為交易作業提供兩個回呼：更新函式和選用的完成回呼。在 Python 和 Go 中，交易作業會阻斷，因此只會接受更新函式。

更新函式會將資料的目前狀態做為引數，並應傳回您要寫入的新狀態。舉例來說，如果您想增加特定網誌文章的讚數，請編寫以下交易：

Java

DatabaseReference upvotesRef = ref.child("server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes");
upvotesRef.runTransaction(new Transaction.Handler() {
  @Override
  public Transaction.Result doTransaction(MutableData mutableData) {
    Integer currentValue = mutableData.getValue(Integer.class);
    if (currentValue == null) {
      mutableData.setValue(1);
    } else {
      mutableData.setValue(currentValue + 1);
    }

    return Transaction.success(mutableData);
  }

  @Override
  public void onComplete(
      DatabaseError databaseError, boolean committed, DataSnapshot dataSnapshot) {
    System.out.println("Transaction completed");
  }
});

Node.js

const upvotesRef = db.ref('server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes');
upvotesRef.transaction((current_value) => {
  return (current_value || 0) + 1;
});

Python

def increment_votes(current_value):
    return current_value + 1 if current_value else 1

upvotes_ref = db.reference('server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes')
try:
    new_vote_count = upvotes_ref.transaction(increment_votes)
    print('Transaction completed')
except db.TransactionAbortedError:
    print('Transaction failed to commit')

Go

fn := func(t db.TransactionNode) (interface{}, error) {
	var currentValue int
	if err := t.Unmarshal(&currentValue); err != nil {
		return nil, err
	}
	return currentValue + 1, nil
}

ref := client.NewRef("server/saving-data/fireblog/posts/-JRHTHaIs-jNPLXOQivY/upvotes")
if err := ref.Transaction(ctx, fn); err != nil {
	log.Fatalln("Transaction failed to commit:", err)
}

上述範例會檢查計數器是否為 null，或尚未遞增，因為如果沒有寫入預設值，則可使用 null 呼叫交易。

如果上述程式碼在沒有交易函式下執行，且有兩個用戶端同時嘗試遞增，則兩者都會將 1 寫入為新值，導致只遞增一次，而非兩次。

交易函式多次呼叫

交易處理常式會多次呼叫，且必須能夠處理 null 資料。即使資料庫中已有資料，在執行交易函式時，可能不會在本機快取。

網路連線和離線寫入

在 Node.js 和 Java 中，如果用戶端失去網路連線，應用程式仍會繼續正常運作。Python 和 Go Admin SDK 會使用 Firebase REST API 與資料庫伺服器通訊，因此需要網路連線。在沒有網路連線的情況下，在 Python 或 Go Admin SDK 上叫用資料庫作業會導致例外狀況。

Firebase Node.js 和 Java 用戶端會維護任何有效資料的內部版本。資料寫入時，系統會先將資料寫入這個本機版本。接著，用戶端會以「盡力而為」的方式，將該資料與資料庫和其他用戶端同步。

因此，所有寫入資料庫的作業都會立即觸發本機事件，甚至在任何資料寫入資料庫之前就會觸發。也就是說，您使用 Firebase 編寫應用程式時，無論網路延遲或網際網路連線為何，應用程式都會持續回應。

重新建立連線後，我們會收到適當的事件組合，讓用戶端「追上」目前的伺服器狀態，而無須撰寫任何自訂程式碼。

保護資料安全

Firebase Realtime Database 提供安全性語言，可讓您定義哪些使用者可讀取及寫入資料的不同節點。如要進一步瞭解，請參閱「保護資料安全」。