儲存資料

本文說明將資料寫入 Firebase 即時資料庫的四種方法：設定、更新、推送和交易支援。

節省資料的方式

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

儲存資料

基本的資料庫寫入作業會將新資料儲存至指定的資料庫參照，取代該路徑中的所有現有資料。為了瞭解設定，我們會建構一個簡易的網誌應用程式。您應用程式的資料會儲存在以下資料庫參考資料：

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 方法，而不要使用推送方法，因為您已擁有金鑰，無須建立金鑰。

首先，為使用者資料建立參照資料庫。然後使用 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)
}

系統會更新小蕾的資料，納入她的暱稱。如果您先前在這裡設定 (而非更新)，這會同時從 hopperRef 中刪除 full_name 和 date_of_birth。

Firebase 即時資料庫也支援多路徑更新。這表示更新作業現在可以同時更新資料庫中多個位置的值，這是強大功能，可讓您將資料去標準化。使用多路徑更新時，您可以同時為 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"
    }
  }
}

新增完成回呼

在 Node.js 和 Java Admin SDK 中，如果您想瞭解資料提交時間，可以新增完成回呼。這些 SDK 中的設定和更新方法都會接受選用的完成回呼，在寫入資料庫後呼叫此回呼。如果呼叫因故失敗，回呼會傳遞錯誤物件，指出失敗的原因。在 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"
    }
  }
}

如果使用者新增貼文，系統會將新貼文儲存為 /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 寫入新值，導致一倍而非兩個值。

網路連線和離線寫入

Firebase Node.js 和 Java 用戶端會維護自己所有有效資料的內部版本。寫入資料時，系統會先將資料寫入這個本機版本。接著，用戶端會「盡可能」將該資料與資料庫及其他用戶端同步處理。

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

重新建立連線後，我們會收到一組適當的事件，讓用戶端能「整合」目前的伺服器狀態，而不必編寫任何自訂程式碼。

保護您的資料

Firebase 即時資料庫提供安全性語言，可讓您定義哪些使用者能夠讀取及寫入不同資料節點。詳情請參閱保護您的資料。