ExCrypto 项目使用教程

2024-08-25 19:17:02作者：苗圣禹Peter

1. 项目的目录结构及介绍

ExCrypto 项目的目录结构如下：

ex_crypto/
├── lib/
│   ├── ex_crypto.ex
│   └── ex_crypto/
│       ├── aes.ex
│       ├── public_key.ex
│       └── utils.ex
├── test/
│   ├── ex_crypto_test.exs
│   └── test_helper.exs
├── .formatter.exs
├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── mix.exs
└── mix.lock

目录结构介绍

lib/: 包含项目的主要代码文件。
- ex_crypto.ex: 主模块文件。
- ex_crypto/: 子模块目录，包含 AES 加密、公钥加密和工具函数。
  - aes.ex: AES 加密相关函数。
  - public_key.ex: 公钥加密相关函数。
  - utils.ex: 工具函数。
test/: 包含项目的测试文件。
- ex_crypto_test.exs: 主测试文件。
- test_helper.exs: 测试辅助文件。
.formatter.exs: 代码格式化配置文件。
.gitignore: Git 忽略文件配置。
CHANGELOG.md: 项目更新日志。
LICENSE.md: 项目许可证。
README.md: 项目说明文档。
mix.exs: 项目配置文件。
mix.lock: 依赖锁定文件。

2. 项目的启动文件介绍

ExCrypto 项目的启动文件是 lib/ex_crypto.ex。这个文件定义了主模块 ExCrypto，并导入了子模块中的函数。

defmodule ExCrypto do
  @moduledoc """
  Documentation for ExCrypto.
  """

  alias ExCrypto.AES
  alias ExCrypto.PublicKey
  alias ExCrypto.Utils

  # 导入了子模块中的函数
  defdelegate generate_aes_key(type, format), to: AES
  defdelegate encrypt(key, iv, plain_text), to: AES
  defdelegate decrypt(key, iv, cipher_text), to: AES
  defdelegate generate_rsa_keys(bits), to: PublicKey
  defdelegate sign(data, private_key), to: PublicKey
  defdelegate verify(data, signature, public_key), to: PublicKey
end

3. 项目的配置文件介绍

ExCrypto 项目的配置文件是 mix.exs。这个文件包含了项目的依赖、版本、描述等信息。

defmodule ExCrypto.MixProject do
  use Mix.Project

  def project do
    [
      app: :ex_crypto,
      version: "0.10.0",
      elixir: "~> 1.7",
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description: description(),
      package: package()
    ]
  end

  def application do
    [
      extra_applications: [:logger, :crypto]
    ]
  end

  defp deps do
    [
      {:poison, ">= 2.0.0"}
    ]
  end

  defp description do
    "A wrapper around the Erlang crypto module with sensible defaults for common tasks"
  end

  defp package do
    [
      licenses: ["MIT"],
      links: %{"GitHub" => "https://github.com/ntrepid8/ex_crypto"}
    ]
  end
end