Mix 是一个构建工具，它提供了用于创建、编译和测试 Elixir 项目、管理其依赖项等等的任务。

Mix.Project

Mix 的基础是一个项目。项目可以通过在模块中使用 Mix.Project 来定义，通常放在名为 mix.exs 的文件中。

defmodule MyApp.MixProject do
  use Mix.Project

  def project do
    [
      app: :my_app,
      version: "1.0.0"
    ]
  end
end

有关 Mix 项目的详细文档，请参阅 Mix.Project 模块。

定义项目后，可以直接从命令行运行许多默认的 Mix 任务。

• mix compile - 编译当前项目
• mix test - 运行给定项目的测试
• mix run - 在项目中运行特定命令

每个任务都有自己的选项，有时需要在 project/0 函数中定义特定的配置。可以使用 mix help 列出所有可用的任务，并使用 mix help NAME 显示特定任务的帮助信息。

从命令行调用 mix new my_project 是开始第一个项目的最佳方法。

Mix.Task

任务使 Mix 可扩展。

项目可以通过添加自己的任务来扩展 Mix 的行为。例如，将下面的任务添加到您的项目中，将使它对使用您项目的每个人可用。

defmodule Mix.Tasks.Hello do
  use Mix.Task

  def run(_) do
    Mix.shell().info("Hello world")
  end
end

现在可以使用 mix hello 调用该任务。

有关 Mix 任务的详细文档，请参阅 Mix.Task 行为。

依赖项

Mix 还管理您的依赖项，并与 Hex 包管理器 无缝集成。

为了使用依赖项，您需要在项目配置中添加 :deps 键。我们通常将依赖项列表提取到自己的函数中

defmodule MyApp.MixProject do
  use Mix.Project

  def project do
    [
      app: :my_app,
      version: "1.0.0",
      deps: deps()
    ]
  end

  defp deps do
    [
      {:ecto, "~> 2.0"},
      {:plug, github: "elixir-lang/plug"}
    ]
  end
end

您可以运行 mix help deps 以了解有关 Mix 中依赖项的更多信息。

环境

Mix 支持不同的环境。环境允许开发人员专门为不同的场景准备和组织他们的项目。默认情况下，Mix 提供三个环境

• :dev - 默认环境
• :test - mix test 运行的环境
• :prod - 您的依赖项运行的环境

可以通过设置 MIX_ENV 环境变量从命令行更改环境，例如

$ MIX_ENV=prod mix run server.exs

您也可以指定某些依赖项仅在特定环境下可用

{:some_test_dependency, "~> 1.0", only: :test}

在通过命令行运行 Mix 时，可以通过 mix.exs 中的 def cli 函数配置默认环境或每个任务的首选环境。例如

def cli do
  [
    default_env: :local,
    preferred_envs: [docs: :docs]
  ]
end

可以通过 Mix.env/0 读取环境。

目标

除了环境，Mix 还支持目标。当项目需要编译到不同的架构，并且某些依赖项仅对其中一些架构可用时，目标非常有用。默认情况下，目标是 :host，但可以通过 MIX_TARGET 环境变量设置。

在通过命令行运行 Mix 时，可以通过 mix.exs 中的 def cli 函数配置默认目标或每个任务的首选目标。例如

def cli do
  [
    default_target: :local,
    preferred_targets: [docs: :docs]
  ]
end

可以通过 Mix.target/0 读取目标。

配置

Mix 允许您配置应用程序和依赖项的应用程序环境。有关应用程序环境的更多信息，请参阅 Application 模块。在本节中，我们将重点介绍如何在两个不同的时间点配置它：构建时和运行时。

避免应用程序环境

不建议在库中使用应用程序环境。有关更多信息，请参阅 Elixir 的 库指南。

构建时配置

无论何时调用 mix 命令，Mix 都会加载 config/config.exs 中的配置，如果该文件存在。 config/config.exs 文件本身通常会根据当前 MIX_ENV 导入其他配置，例如 config/dev.exs、config/test.exs 和 config/prod.exs，通过调用 Config.import_config/1

import Config
import_config "#{config_env()}.exs"

我们说 config/config.exs 和所有导入的文件是构建时配置，因为它们会在您编译代码时进行评估。换句话说，如果您的配置执行类似以下操作

import Config
config :my_app, :secret_key, System.fetch_env!("MY_APP_SECRET_KEY")

:my_app 下的 :secret_key 键将在您的代码编译之前在主机上计算。如果编译代码的机器无法访问用于运行代码的所有环境变量，这可能会成为问题，因为加载上面的配置将由于缺少环境变量而失败。此外，即使设置了环境变量，更改环境变量也需要通过调用 mix compile --force 重新编译您的应用程序（否则您的项目将无法启动）。幸运的是，Mix 还提供运行时配置，在这些情况下是首选，我们将在下面看到。

运行时配置

要在您的发行版中启用运行时配置，您只需要创建一个名为 config/runtime.exs 的文件。

import Config
config :my_app, :secret_key, System.fetch_env!("MY_APP_SECRET_KEY")

该文件在您的项目运行时执行。如果您使用 mix release 构建发行版，它也会在您的发行版启动时每次执行。

别名

别名是当前项目特定的快捷方式或任务。

在 Mix.Task 部分，我们定义了一个对使用我们的项目作为依赖项的每个人都可用的任务。如果我们想让该任务仅对我们的项目可用，该怎么办？只需定义一个别名。

defmodule MyApp.MixProject do
  use Mix.Project

  def project do
    [
      app: :my_app,
      version: "1.0.0",
      aliases: aliases()
    ]
  end

  defp aliases do
    [
      c: "compile",
      hello: &hello/1,
      paid_task: &paid_task/1
    ]
  end

  defp hello(_) do
    Mix.shell().info("Hello world")
  end

  defp paid_task(_) do
    Mix.Task.run("paid.task", [
      "first_arg",
      "second_arg",
      "--license-key",
      System.fetch_env!("SOME_LICENSE_KEY")
    ])
  end
end

在上面的示例中，我们定义了三个别名。一个是 mix c，它是 mix compile 的快捷方式。另一个名为 mix hello，第三个名为 mix paid_task，它在自定义函数中执行代码以使用多个参数调用 paid.task 任务，包括从环境变量中提取的一个参数。

别名也可以是列表，指定要连续运行的多个任务。

[all: [&hello/1, "deps.get --only #{Mix.env()}", "compile"]]

在上面的示例中，我们定义了一个名为 mix all 的别名，它打印“Hello world”，然后获取特定于当前环境的依赖项，并编译项目。

别名也可以用于增强现有任务。假设您想增强 mix clean 以清理 Mix 不知道的另一个目录。

[clean: ["clean", &clean_extra/1]]

其中 &clean_extra/1 将是您 mix.exs 中具有额外清理逻辑的函数。

如果别名正在覆盖现有任务，则传递给别名的参数将转发给原始任务，以保留语义。否则，传递给别名的参数将追加到列表中最后一个任务的参数。

别名的另一个用例是运行 Elixir 脚本和 shell 命令，例如

# priv/hello1.exs
IO.puts("Hello One")

# priv/hello2.exs
IO.puts("Hello Two")

# priv/world.sh
#!/bin/sh
echo "world!"

# mix.exs
defp aliases do
  [
    some_alias: ["hex.info", "run priv/hello1.exs", "cmd priv/world.sh"]
  ]
end

在上面的示例中，我们创建了别名 some_alias，它将运行任务 mix hex.info，然后 mix run 运行 Elixir 脚本，然后 mix cmd 执行命令行 shell 脚本。这展示了别名与 Mix 任务结合使用时的强大功能。

别名的一个常见问题是尝试多次调用同一个任务。Mix 任务设计为只运行一次。这可以防止同一个任务多次执行。例如，如果有几个任务依赖于 mix compile，代码将只编译一次。

类似地，mix format 只能调用一次。因此，如果您有一个尝试多次调用 mix format 的别名，它将无法工作，除非使用 Mix.Task.reenable/1 明确重新启用它。

another_alias: [
  "format --check-formatted priv/hello1.exs",
  "cmd priv/world.sh",
  fn _ -> Mix.Task.reenable("format") end,
  "format --check-formatted priv/hello2.exs"
]

不过，一些任务会自动重新启用，因为它们预计会多次调用，例如：mix cmd、mix do、mix xref 等等。

最后，在当前项目中定义的别名不会影响其依赖项，并且在依赖项中定义的别名无法从当前项目访问，伞形项目除外。当伞形项目本身没有定义该别名，并且没有与该名称匹配的任务时，伞形项目将运行其子项目的别名。

环境变量

可以使用多个环境变量来修改 Mix 的行为。

Mix 响应以下变量

• MIX_ARCHIVES - 指定应安装存档的目录（默认：~/.mix/archives）

• MIX_BUILD_PATH - 设置项目的 Mix.Project.build_path/0 配置。此选项必须始终指向临时目录中的子目录。例如，不要使用“/tmp”或“_build”，而是使用“_build/PROD”或“/tmp/PROD”，如 Mix 所需。此环境变量主要由外部构建工具使用。对于您的 CI 服务器，您可能希望使用下面的 MIX_BUILD_ROOT。

• MIX_BUILD_ROOT - 设置应将构建工件写入的根目录。例如，"_build"。如果设置了 MIX_BUILD_PATH，则此选项将被忽略。

• MIX_DEBUG - 输出有关每个任务的调试信息，然后再运行它。

• MIX_DEPS_PATH - 设置当前项目的 Mix.Project.deps_path/0 配置（默认：deps）

• MIX_ENV - 指定要使用的环境。请参阅 环境

• MIX_EXS - 更改 mix.exs 文件的完整路径

• MIX_HOME - Mix 主目录的路径，存储 Mix 使用的配置文件和脚本（默认：~/.mix）

• MIX_INSTALL_DIR - （自 v1.12.0 起）指定 Mix.install/2 保留安装缓存的目录

• MIX_PATH - 附加额外的代码路径

• MIX_PROFILE - 一个逗号分隔的 Mix 任务列表，用于分析运行任务的进程在函数上花费的时间

• MIX_QUIET - 不打印信息消息到终端

• MIX_REBAR3 - rebar3 命令的路径，它覆盖了 Mix 安装的路径（默认：~/.mix/rebar3）

• MIX_TARGET - 指定要使用的目标。请参阅 目标

• MIX_XDG - 要求 Mix 遵循 XDG 目录规范 来设置其主目录和配置文件。由于向后兼容性，此行为需要选择加入。 MIX_HOME 的优先级高于 MIX_XDG。如果未设置任何变量，将使用默认目录 ~/.mix

不打算保存值的環境變數（基本上充當旗標）應該設定為 1 或 true，例如

$ MIX_DEBUG=1 mix compile