Bạn có thể cho phép người dùng của mình xác thực với Firebase bằng tài khoản GitHub của họ bằng cách tích hợp Đăng nhập OAuth chung dựa trên web vào ứng dụng của bạn 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 nhà cung cấp dịch vụ đăng nhập cho dự án Firebase của mình:
Nếu bạn chưa có, hãy thêm Firebase vào dự án Android của bạn .
- Trong bảng điều khiển Firebase , hãy mở phần Auth .
- Trên tab Phương thức đăng nhập , bật nhà cung cấp GitHub .
- Thêm Client ID và Client Secret từ 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 nhà cung cấp:
- Đăng ký ứng dụng của bạn dưới dạng ứng dụng dành cho nhà phát triển trên GitHub và nhận ID ứng dụng khách OAuth 2.0 và Bí mật ứng dụng khách .
- Đảm bảo rằng URI chuyển hướng OAuth Firebase của bạn (ví dụ:
my-app-12345.firebaseapp.com/__/auth/handler) được đặt làm URL gọi lại Ủy quyền trong trang cài đặt của ứng dụng trên cấu hình ứng dụng GitHub của bạn.
- Nhấp vào Lưu .
Trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là
<project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho thư viện Android Xác thực Firebase. Chúng tôi khuyên bạn nên sử dụng Firebase Android BoM để kiểm soát việc lập phiên bản thư viện.Kotlin+KTX
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:32.1.0') // 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-ktx' }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 Firebase.
(Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần sử dụng BoM
Nếu chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc của nó.
Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đảm bảo rằng 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-ktx:22.0.0' }Java
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:32.1.0') // 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 Firebase.
(Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần sử dụng BoM
Nếu chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc của nó.
Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đảm bảo rằng 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:22.0.0' }Nếu bạn chưa chỉ định dấu vân tay SHA-1 cho ứng dụng của mình, hãy làm như vậy từ trang Cài đặt của bảng điều khiển Firebase. Tham khảo Xác thực ứng dụng khách của bạn để biết chi tiết về cách lấy dấu vân tay SHA-1 cho ứng dụng của bạn.
Xử lý luồng đăng nhập bằng SDK Firebase
Nếu bạn đang xây dựng một ứng dụng Android, thì cách dễ dàng nhất để xác thực người dùng của bạn bằng Firebase bằng tài khoản GitHub của họ là xử lý toàn bộ quy trình đăng nhập bằng SDK Android của Firebase.
Để xử lý luồng đăng nhập bằng SDK Android Firebase, hãy làm theo các bước sau:
Xây dựng phiên bản của OAuthProvider bằng Trình tạo của nó với ID nhà cung cấp github.com
Kotlin+KTX
val provider = OAuthProvider.newBuilder("github.com")Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("github.com");Tùy chọn : Chỉ định các tham số OAuth tùy chỉnh bổ sung 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 GitHub OAuth . Lưu ý rằng bạn không thể chuyển các tham số bắt buộc của Firebase với
setCustomParameters(). Các tham số này là client_id , response_type , redirect_uri , state , scope và response_mode .Tùy chọn : Chỉ định các phạm vi OAuth 2.0 bổ sung ngoài cấu hình cơ bản mà bạn muốn yêu cầu từ nhà cung cấp 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 người dùng riêng tư từ API GitHub, thì bạn sẽ cần yêu cầu quyền truy cập API GitHub trong phần Quyền API trong 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 phạm vi được định cấu hình sẵn trong quyền 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 với Firebase bằng đối tượng nhà cung cấp OAuth. Lưu ý rằng không giống như các hoạt động FirebaseAuth khác, thao tác này sẽ kiểm soát giao diện người dùng của bạn bằng cách bật lên Tab Chrome tùy chỉnh . Do đó, không tham chiếu 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 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 chưa. Đăng nhập bằng phương pháp này sẽ đặt Hoạt động của bạn ở chế độ nền, điều đó có nghĩa là hệ thống có thể lấy lại Hoạt động đó trong quy trình đăng nhập. Để đảm bảo rằng bạn không bắt người dùng thử lại nếu điều này xảy ra, bạn nên kiểm tra xem đã có kết quả 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, mã thông báo truy cập OAuth được liên kết với nhà cung cấp có thể được truy xuất từ đối tượng
OAuthCredentialđược trả về.Sử dụng mã thông báo truy cập OAuth, bạn có thể gọi API GitHub .
Ví dụ: để nhận thông tin cấu hình cơ bản, bạn có thể gọi API REST, chuyển mã thông báo truy cập trong tiêu đề
Authorization:Mặc dù các ví dụ trên tập trung vào luồng đăng nhập, nhưng bạn cũng có khả năng liên kết nhà cung cấp GitHub với người dùng hiện có bằng cách sử dụ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. } });Mẫu tương tự có thể được sử dụng với
startActivityForReauthenticateWithProvidercó thể được sử dụng để truy xuất thông tin đăng nhập mới cho các hoạt động 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. } });
Bước tiếp theo
Sau khi người dùng đăng nhập lần đầu tiên, tài khoản người dùng mới được tạo và liên kết với thông tin đăng nhập—nghĩa là tên người dùng và mật khẩu, số điện thoại hoặc thông tin nhà cung cấp xác thực—người dùng đã đăng nhập bằng. Tài khoản mới này được lưu trữ như một phần của dự án Firebase của bạn và có thể được sử 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 của mình, 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 Quản lý người dùng .Trong Cơ sở dữ liệu thời gian thực Firebase và Quy tắc bảo mật bộ lưu trữ đám mây , bạn có thể lấy ID người dùng duy nhất của người dùng đã đăng nhập từ biến
authvà sử dụng biến đó để kiểm soát 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 bằng nhiều nhà cung cấp xác thực bằng cách liên kết thông tin đăng nhập của nhà cung cấp xác thực với tài khoản người dùng hiện có.
Để đăng xuất người dùng, hãy gọi signOut :
Kotlin+KTX
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();