Bạn có thể cho phép người dùng xác thực với Firebase thông qua tài khoản GitHub của họ bằng cách tích hợp tính năng Đăng nhập OAuth chung dựa trên nền tảng web vào ứng dụng bằng SDK Firebase để thực hiện quy trình đăng nhập từ đầu đến cuối.
Trước khi bắt đầu
Để đăng nhập người dùng bằng tài khoản GitHub, trước tiên bạn phải bật GitHub làm trình cung cấp đăng nhập cho dự án Firebase của mình:
Thêm Firebase vào dự án Android của bạn nếu bạn chưa thêm.
- Trong bảng điều khiển của Firebase, hãy mở phần Xác thực.
- Trên thẻ Phương thức đăng nhập, hãy bật nhà cung cấp GitHub.
- Thêm Mã ứng dụng khách và Mật khẩu ứng dụng khách trong bảng điều khiển dành cho nhà phát triển của nhà cung cấp đó vào cấu hình của nhà cung cấp:
- Đăng ký ứng dụng của bạn với tư cách là một ứng dụng của nhà phát triển trên GitHub và lấy Mã ứng dụng khách OAuth 2.0 và Bí mật ứng dụng khách của ứng dụng.
- Đảm bảo URI chuyển hướng OAuth trong Firebase (ví dụ:
my-app-12345.firebaseapp.com/__/auth/handler) được đặt thành URL gọi lại ủy quyền trong trang cài đặt của ứng dụng trên cấu hình của ứng dụng GitHub.
- Nhấp vào Lưu.
Trong tệp Gradle (ở cấp ứng dụng) mô-đun (thường là
<project>/<app-module>/build.gradle.ktshoặc<project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho Thư viện xác thực Firebase dành cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc tạo phiên bản thư viện.dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.1.1")) // Add the dependency for the Firebase Authentication library // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth") }Bằng cách sử dụng Firebase Android BoM, ứng dụng của bạn sẽ luôn sử dụng các phiên bản tương thích của thư viện Android trên Firebase.
(Thay thế) Thêm các phần phụ thuộc của thư viện Firebase mà không sử dụng BoM
Nếu chọn không sử dụng BoM của Firebase, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc.
Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, thì bạn nên sử dụng BoM để quản lý các phiên bản thư viện, qua đó đảm bảo tất cả các phiên bản đều tương thích.
dependencies { // Add the dependency for the Firebase Authentication library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth:23.0.0") }Nếu bạn chưa chỉ định vân tay số SHA-1 của ứng dụng, hãy thực hiện trên trang Cài đặt của bảng điều khiển của Firebase. Hãy tham khảo bài viết Xác thực ứng dụng của bạn để biết thông tin chi tiết về cách lấy vân tay SHA-1 của ứng dụng.
Xử lý quy trình đăng nhập bằng Firebase SDK
Nếu bạn đang tạo một ứng dụng Android, thì cách dễ nhất để xác thực người dùng với Firebase bằng tài khoản GitHub là xử lý toàn bộ quy trình đăng nhập bằng SDK Android của Firebase.
Để xử lý quy trình đăng nhập bằng SDK Android của Firebase, hãy làm theo các bước sau:
Tạo một thực thể của OAuthProvider bằng cách sử dụng Builder với mã nhà cung cấp github.com
Kotlin+KTX
val provider = OAuthProvider.newBuilder("github.com")Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");Không bắt buộc: Chỉ định các thông số OAuth tuỳ chỉnh khác mà bạn muốn gửi cùng với yêu cầu OAuth.
Kotlin+KTX
// Target specific email with login hint. provider.addCustomParameter("login", "your-email@gmail.com")Java
// Target specific email with login hint. provider.addCustomParameter("login", "your-email@gmail.com");Để biết các tham số mà GitHub hỗ trợ, hãy xem tài liệu về OAuth của GitHub. Xin lưu ý rằng bạn không thể truyền các tham số bắt buộc của Firebase bằng
setCustomParameters(). Các tham số này là client_id, response_type, redirect_uri, state, scope và response_mode.Không bắt buộc: Chỉ định các phạm vi OAuth 2.0 khác ngoài hồ sơ cơ bản mà bạn muốn yêu cầu từ nhà cung cấp dịch vụ xác thực. Nếu ứng dụng của bạn yêu cầu quyền truy cập vào dữ liệu riêng tư của người dùng từ API GitHub, thì bạn sẽ cần yêu cầu quyền truy cập vào API GitHub trong phần Quyền API trên bảng điều khiển dành cho nhà phát triển GitHub. Phạm vi OAuth được yêu cầu phải khớp chính xác với các phạm vi được định cấu hình sẵn trong phần Quyền đối với API của ứng dụng.
Kotlin+KTX
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. provider.scopes = listOf("user:email")Java
// Request read access to a user's email addresses. // This must be preconfigured in the app's API permissions. List<String> scopes = new ArrayList<String>() { { add("user:email"); } }; provider.setScopes(scopes);Xác thực bằng Firebase bằng đối tượng nhà cung cấp OAuth. Xin lưu ý rằng không giống như các thao tác FirebaseAuth khác, thao tác này sẽ kiểm soát giao diện người dùng bằng cách bật lên Thẻ Chrome tuỳ chỉnh. Do đó, đừng tham chiếu đến Hoạt động của bạn trong
OnSuccessListenervàOnFailureListenermà bạn đính kèm vì chúng sẽ tách ra ngay lập tức khi thao tác này khởi động giao diện người dùng.Trước tiên, bạn nên kiểm tra xem mình đã nhận được phản hồi hay chưa. Khi đăng nhập thông qua phương thức này, Hoạt động của bạn sẽ được chuyển sang chế độ nền, có nghĩa là hệ thống có thể xác nhận lại quyền sở hữu trong quy trình đăng nhập. Để đảm bảo rằng mình không yêu cầu người dùng thử lại trong trường hợp này, bạn nên kiểm tra xem đã có kết quả hay chưa.
Để kiểm tra xem có kết quả đang chờ xử lý hay không, hãy gọi
getPendingAuthResult:Kotlin+KTX
val pendingResultTask = firebaseAuth.pendingAuthResult if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. } } else { // There's no pending result so you need to start the sign-in flow. // See below. }Java
Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult(); if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } }); } else { // There's no pending result so you need to start the sign-in flow. // See below. }Để bắt đầu quy trình đăng nhập, hãy gọi
startActivityForSignInWithProvider:Kotlin+KTX
firebaseAuth .startActivityForSignInWithProvider(activity, provider.build()) .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. }Java
firebaseAuth .startActivityForSignInWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });Sau khi hoàn tất thành công, bạn có thể truy xuất mã truy cập OAuth liên kết với trình cung cấp từ đối tượng
OAuthCredentialđược trả về.Bằng cách sử dụng mã truy cập OAuth, bạn có thể gọi API GitHub.
Ví dụ: để nhận thông tin hồ sơ cơ bản, bạn có thể gọi API REST, truyền mã truy cập trong tiêu đề
Authorization:Mặc dù các ví dụ trên tập trung vào quy trình đăng nhập, nhưng bạn cũng có thể liên kết nhà cung cấp GitHub với người dùng hiện có bằng
startActivityForLinkWithProvider. Ví dụ: bạn có thể liên kết nhiều nhà cung cấp với cùng một người dùng để cho phép họ đăng nhập bằng một trong hai nhà cung cấp đó.Kotlin+KTX
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForLinkWithProvider(activity, provider.build()) .addOnSuccessListener { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } .addOnFailureListener { // Handle failure. }Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForLinkWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });Bạn có thể dùng cùng một mẫu với
startActivityForReauthenticateWithProviderđể truy xuất thông tin xác thực mới cho các thao tác nhạy cảm yêu cầu đăng nhập gần đây.Kotlin+KTX
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForReauthenticateWithProvider(activity, provider.build()) .addOnSuccessListener { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } .addOnFailureListener { // Handle failure. }Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
Các bước tiếp theo
Sau khi người dùng đăng nhập lần đầu tiên, một tài khoản người dùng mới sẽ được tạo và liên kết với thông tin đăng nhập (chẳng hạn như tên người dùng và mật khẩu, số điện thoại hoặc thông tin của nhà cung cấp dịch vụ xác thực) mà người dùng đã đăng nhập. Tài khoản mới này được lưu trữ như một phần trong dự án Firebase và có thể được dùng để xác định người dùng trên mọi ứng dụng trong dự án của bạn, bất kể người dùng đăng nhập bằng cách nào.
-
Trong các ứng dụng, bạn có thể lấy thông tin hồ sơ cơ bản của người dùng từ đối tượng
FirebaseUser. Xem phần Quản lý người dùng. Trong Quy tắc bảo mật của Cloud Storage và Cơ sở dữ liệu theo thời gian thực của Firebase, bạn có thể lấy mã nhận dạng người dùng riêng biệt của người dùng đã đăng nhập từ biến
authrồi sử dụng mã này để kiểm soát những dữ liệu mà người dùng có thể truy cập.
Bạn có thể cho phép người dùng đăng nhập vào ứng dụng của mình thông qua nhiều nhà cung cấp dịch vụ xác thực bằng cách liên kết thông tin đăng nhập của nhà cung cấp dịch vụ xác thực với một tài khoản người dùng hiện có.
Để đăng xuất một người dùng, hãy gọi
signOut:
Kotlin+KTX
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();