Serverpod Authentication

Serverpod 认证

Serverpod has authentication built in. Projects created with

serverpod create

have it enabled by default (unless

--no-auth

, or the project has no database), pre-configured with email and already wired up in

lib/server.dart

and in the Flutter app.

In server application code, import

package:serverpod_auth_idp_server/core.dart

and

package:serverpod_auth_idp_server/providers/<provider>.dart

. Do NOT import

package:serverpod_auth_idp_server/serverpod_auth_idp_server.dart

— that library exists for the code generator.

Serverpod 内置了认证功能。使用

serverpod create

创建的项目默认启用该功能（除非使用

--no-auth

参数，或项目未配置数据库），已预先配置邮箱认证，并在

lib/server.dart

和 Flutter 应用中完成了相关对接。

在服务端应用代码中，导入

package:serverpod_auth_idp_server/core.dart

和

package:serverpod_auth_idp_server/providers/<provider>.dart

。请勿导入

package:serverpod_auth_idp_server/serverpod_auth_idp_server.dart

—— 该库仅用于代码生成。

Server-side

服务端

Require the user to be signed in or have a specific scope

要求用户登录或拥有特定权限范围

dart

class MyEndpoint extends Endpoint {
  // Require the user to be signed in to access methods in this endpoint.
  @override
  bool get requireLogin => true;

  // Require the user to have the admin scope.
  @override
  Set<Scope> get requiredScopes => {Scope.admin};

  // This method can only be accessed if the user is admin.
  Future<void> myMethod(Session session) async {
    ...
  }
  ...
}

dart

class MyEndpoint extends Endpoint {
  // 要求用户登录才能访问此端点中的方法。
  @override
  bool get requireLogin => true;

  // 要求用户拥有管理员权限范围。
  @override
  Set<Scope> get requiredScopes => {Scope.admin};

  // 此方法仅允许管理员用户访问。
  Future<void> myMethod(Session session) async {
    ...
  }
  ...
}

User id and info

用户 ID 与信息

dart

import 'package:serverpod_auth_idp_server/core.dart';

// Get authenticated user's ID.
final userIdUuidValue = session.authenticated?.authUserId;

// Get the user profile (full name, email, etc)
var userProfile = await session.authenticated?.userProfile(session);

// Find a user profile by email.
final profiles = await AuthServices.instance.userProfiles.admin
    .listUserProfiles(
      session,
      email: email.toLowerCase(),
      limit: 1,
    );
final userProfile = profiles.firstOrNull;

// Get authentication info for user id (for editing scopes, etc).
final authUsers = AuthServices.instance.authUsers;
final authUser = await authUsers.get(
  session,
  authUserId: userProfile.authUserId,
);

dart

import 'package:serverpod_auth_idp_server/core.dart';

// 获取已认证用户的 ID。
final userIdUuidValue = session.authenticated?.authUserId;

// 获取用户资料（全名、邮箱等）
var userProfile = await session.authenticated?.userProfile(session);

// 通过邮箱查找用户资料。
final profiles = await AuthServices.instance.userProfiles.admin
    .listUserProfiles(
      session,
      email: email.toLowerCase(),
      limit: 1,
    );
final userProfile = profiles.firstOrNull;

// 根据用户 ID 获取认证信息（用于编辑权限范围等操作）。
final authUsers = AuthServices.instance.authUsers;
final authUser = await authUsers.get(
  session,
  authUserId: userProfile.authUserId,
);

Flutter app

Flutter 应用

Use

SignInWidget

to sign the user in. It provides its own Material surface, so it also renders correctly when mixed with non-Material design systems:

dart

SignInWidget(
  client: client,
  onAuthenticated: () => _showSnackBar(message: 'User authenticated.'),
  onError: (error) => _showSnackBar(message: 'Authentication failed: $error'),
)

Signed-in state:

client.auth.isAuthenticated

. Rebuild on changes by listening to

client.auth.authInfoListenable

(a

ValueListenable<AuthSuccess?>

, so

ValueListenableBuilder

works too), and remove the listener in

dispose

.

Sign out:

client.auth.signOutAllDevices()

or

client.auth.signOutDevice()

.

User profile (email, full name, etc):

await client.modules.serverpod_auth_core.userProfileInfo.get()

.

使用

SignInWidget

实现用户登录。它自带 Material 界面，因此与非 Material 设计系统混合使用时也能正常渲染：

dart

SignInWidget(
  client: client,
  onAuthenticated: () => _showSnackBar(message: 'User authenticated.'),
  onError: (error) => _showSnackBar(message: 'Authentication failed: $error'),
)

登录状态：
```
client.auth.isAuthenticated
```
。可通过监听
```
client.auth.authInfoListenable
```
（一个
```
ValueListenable<AuthSuccess?>
```
，也可使用
```
ValueListenableBuilder
```
）在状态变化时重建界面，并在
```
dispose
```
中移除监听器。

登出：

client.auth.signOutAllDevices()

或

client.auth.signOutDevice()

。

用户资料（邮箱、全名等）：

await client.modules.serverpod_auth_core.userProfileInfo.get()

。

serverpod-auth

Original

Translation

Serverpod Authentication

Serverpod 认证

Server-side

服务端

Require the user to be signed in or have a specific scope

要求用户登录或拥有特定权限范围

User id and info

用户 ID 与信息

Flutter app

Flutter 应用

More

更多内容