Flutter安全守护插件guard_runner的使用

特性

• 防止未授权访问路由
• 验证执行操作的权限
• 根据用户的角色显示或隐藏小部件

安装

在项目的 pubspec.yaml 文件中添加 guard_runner 作为依赖：

dependencies:
  guard_runner: any

使用

设置角色、路由和isAdmin

首先，需要调用 GuardRunner.setup 来加载所有角色、路由及其相应的角色。

import 'package:guard_runner/guard_runner.dart';
...
/// 允许的所有角色
final List<String> roles = ['app_first_role', 'app_second_role', 'admin_role'];

/// 应用程序的路由及其相应的角色
final rolesByRoutes = GuardRunnerRouteModelList([
  GuardRunnerRouteModel(routeName: '/', roles: ['*']),
  GuardRunnerRouteModel(routeName: '/second-page', roles: ['app_first_role', 'app_second_role']),
  GuardRunnerRouteModel(routeName: '/third-page', roles: ['app_third_role']),
  GuardRunnerRouteModel(routeName: '/unauthorized-page', roles: ['*'])
]);

GuardRunner.setup(
  roles: roles,
  rolesByRoutes: rolesByRoutes,
  isAdminRole: 'admin_role');

检查路由是否有导航权限

警告：这是一个示例，你可以根据需要进行调整。

import 'package:guard_runner/guard_runner.dart';
...
@override
class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      initialRoute: '/',
      onGenerateRoute: (settings) {
        final routeName = settings.name;

        final routes = {
          '/': MyHomePage(title: 'GuardRunner Home Page'),
          '/second-page': SecondPage(),
          '/third-page': ThirdPage(),
          '/unauthorized-page': UnauthorizedPage(),
        };

        if (routes.keys.contains(routeName)) {
          final hasPermission = GuardRunner.hasPermissionFromRoute(routeName!);

          return MaterialPageRoute(
            builder: (context) {
              final toRoute = hasPermission ? routeName : '/unauthorized-page';
              return routes[toRoute]!;
            },
          );
        }

        assert(false, '需要实现 ${settings.name}');
        return null;
      },
    );
  }
}

在这个示例中，如果有权限，则导航到目标路由；如果没有权限，则跳转到未经授权页面。

验证权限

要验证用户是否有执行某个操作的权限，可以使用 GuardRunner.hasPermission 和/或 GuardRunner.hasPermissionFromRoute。

import 'package:guard_runner/guard_runner.dart';
...

if (GuardRunner.hasPermission(['app_first_role'])) {
  doSomething();
} else {
  doNothing();
}

///
if (GuardRunner.hasPermissionFromRoute('/third-page')) {
  Navigator.of(context).pushNamed('/third-page');
} else {
  Navigator.of(context).pushNamed('/third-page');
}

使用 GuardRunnerVisibility 显示或隐藏小部件

GuardRunnerVisibility 是一个可以根据角色参数显示或隐藏其子部件的小部件。

import 'package:guard_runner/guard_runner.dart';
...
GuardRunnerVisibility(
  child: Text('显示因为有权限...'),
  roles: ['app_first_role'],
)

传递通配符作为参数

如果你希望某个路由完全访问或显示 GuardRunnerVisibility 的子部件，可以传递通配符作为参数。

import 'package:guard_runner/guard_runner.dart';
...

/// 在路由中使用通配符的示例
GuardRunnerRouteModel(routeName: '/', roles: ['*']),

/// 使用通配符与 GuardRunnerVisibility 的示例
GuardRunnerVisibility(
  child: Text('显示因为有权限...'),
  roles: ['*'],
)

设置isAdmin

如果你希望给用户完全访问权限，可以在调用 GuardRunner.setup 时设置 isAdminRole 属性。

isAdminRole 是可选的，如果定义且包含在角色列表中，则将定义完全访问权限。

import 'package:guard_runner/guard_runner.dart';
...
/// 允许的所有角色
final List<String> roles = ['app_first_role', 'app_second_role', 'admin_role'];

GuardRunner.setup(
  roles: roles,
  rolesByRoutes: rolesByRoutes,
  isAdminRole: 'admin_role');