Pundit - 简化 Rails 应用中的授权管理

Pundit - 简化 Rails 应用中的授权管理

Pundit 是一个 Ruby on Rails 框架的简单授权库，可以帮助开发者轻松地在应用中实现细粒度的权限控制。通过基于对象的策略，Pundit 可以帮助您更好地组织代码，并确保您的应用程序能够安全地处理敏感数据。

为什么需要 Pundit？

在开发 Rails 应用程序时，我们通常会遇到许多与用户角色和权限相关的问题。例如，管理员可以访问所有记录，而普通用户只能查看自己的记录等。如果没有合适的工具，这些场景会导致代码变得混乱且难以维护。

Pundit 提供了一种简洁的方法来解决这些问题。它将授权逻辑从业务逻辑中分离出来，使得代码更加清晰、易于测试和扩展。此外，Pundit 还提供了大量的默认功能，如方法注入和自动记录不允许的操作，这使得在大型 Rails 应用程序中使用 Pundit 成为一种愉快的体验。

如何使用 Pundit？

1. 安装 Pundit gem

要在您的 Rails 应用程序中使用 Pundit，请首先在 Gemfile 中添加以下行：

gem 'pundit'

然后运行 bundle install 命令安装 gem。

2. 创建策略文件

接下来，创建一个策略文件并将其放在 app/policies 目录中。每个策略文件对应一个模型，定义了该模型上允许执行的操作。例如，对于名为 Post 的模型，您可以创建一个名为 post_policy.rb 的文件，如下所示：

class PostPolicy < ApplicationPolicy
  def index?
    user.admin?
  end

  def show?
    user.admin? || record.user == user
  end

  def create?
    user.admin? || record.user == user
  end

  def update?
    user.admin? || record.user == user
  end

  def destroy?
    user.admin?
  end
end

在这个示例中，我们定义了一些基本操作（index、show、create、update 和 destroy），并对每个操作指定了相应的授权规则。在这个例子中，只有管理员或拥有记录的用户才能执行这些操作。

3. 在控制器中使用 Pundit

为了使 Pundit 能够生效，您需要在相关的控制器中引入政策类。这通常是通过包含 Pundit::ControllerResource 模块并在控制器中定义资源的方式来完成的。

class PostsController < ApplicationController
  include Pundit::ControllerResource

  resource :post, only: [:index, :show, :create, :update, :destroy]
end

现在，在控制器中调用 policy_scope 方法将返回经过筛选的记录集，根据当前用户的权限进行过滤。

def index
  @posts = policy_scope(Post)
end

同样，您可以通过调用 policy 方法获取特定记录的策略实例，并使用该实例来检查特定操作的权限。

def update
  @post = Post.find(params[:id])
  authorize @post

  if @post.update(post_params)
    redirect_to @post, notice: 'Post updated successfully.'
  else
    render :edit
  end
end

4. 测试策略

要确保您的策略按预期工作，请在 spec 文件夹中创建一个 policies 子目录，并为每个策略编写对应的 RSpec 测试。

require 'rails_helper'

RSpec.describe PostPolicy do
  let(:admin) { FactoryBot.create(:user, admin: true) }
  let(:normal_user) { FactoryBot.create(:user) }

  shared_examples_for "an admin" do
    it { is_expected.to permit(admin, Post.new) }
  end

  shared_examples_for "a normal user" do
    context "when the post belongs to them" do
      subject { described_class.new(normal_user, FactoryBot.build(:post, user: normal_user)) }

      it { is_expected.to permit(normal_user, FactoryBot.build(:post, user: normal_user)) }
    end

    context "when the post doesn't belong to them" do
      subject { described_class.new(normal_user, FactoryBot.build(:post)) }

      it { is_expected.not_to permit(normal_user, FactoryBot.build(:post)) }
    end
  end

  describe "#index?" do
    subject { described_class.new(user, Post.new) }

    it_behaves_like "an admin"
    it_behaves_like "a normal user"
  end

  # ... (其他操作的测试)
end

这样，您就可以确保所有的授权规则都得到了适当的测试和验证。

Pundit 的特点

• 易用性：Pundit 的 API 简单直观，只需很少的学习曲线即可开始使用