Guardian开源项目教程

一、项目目录结构及介绍

Guardian是一款基于Elixir语言开发的身份验证库，专为Phoenix框架设计，但也适用于其他Elixir Web应用。其目录结构展示了清晰的组织逻辑，便于开发者快速上手。

guardian/
|-- lib/
|   |-- guardian/                    # 核心库代码所在，包括Token处理、认证逻辑等
|   |   |-- auth_token.ex            # 认证令牌的处理模块
|   |   |-- guardian.ex               # 主入口模块，定义了守护进程行为
|   |-- guardian_db/                 # 提供数据库支持的模块
|       |-- token.ex                 # 数据库存储的Token模型
|-- priv/                            # 私有资源目录，如配置示例
|   |-- dev.jwt                      # 开发环境JWT密钥示例
|-- test/                            # 测试代码
|-- mix.exs                          # Mix项目的配置文件
|-- README.md                        # 项目快速入门和概述

二、项目的启动文件介绍

在Guardian项目中，并没有传统意义上的“启动文件”，因为它是作为库被引入到你的Elixir应用中的。不过，集成Guardian时，关键在于配置和初始化。这通常在你的应用程序的config/config.exs或特定环境配置文件（如config/dev.exs, config/prod.exs）中完成。通过以下方式添加Guardian到应用并设置默认配置：

def application do
  [applications: [:guardian]]
end

defp deps do
  [{:guardian, "~> 2.0"}]
end

# 在对应的环境配置文件中初始化Guardian
config :my_app, MyApp.Auth,
  issuer: "My App",
  secret_key_base: System.get_env("GUARDIAN_SECRET_KEY_BASE"),
  module: MyApp.Guardian,
  token_provider: Guardian.DB.Token

这里，MyApp.Auth是你的认证模块，负责与Guardian交互的具体实现细节。

三、项目的配置文件介绍

Guardian的配置主要是通过Elixir应用的配置文件进行的，而非独立的配置文件。关键配置项通常分散在你的应用的config/*.exs文件中。除了在启动文件示例中提到的基本配置外，还可以自定义多种行为，比如过期时间、刷新策略等：

config :my_app, MyApp.Guardian,
  jwt_algorithms: ["HS256"],
  # 设置访问令牌有效期
  replay_window: 60,
  ttl: {30, :minutes},               # 示例访问令牌的生命周期
  refresh_ttl: {7, :days}             # 刷新令牌的有效期

# 若要使用数据库存储令牌
config :guardian_db,
  repo: MyApp.Repo,
  table: MyApp.AuthToken             # 存储认证令牌的数据库表

以上就是对Guardian项目核心目录结构、启动机制以及配置文件的简要介绍，希望对你理解和使用Guardian有所帮助。记得根据实际应用需求调整配置项。