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.Project 模組以取得 Mix 專案的詳細文件。

定義專案後，許多預設 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.Task 行為以取得 Mix 任務的詳細文件。

相依性

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 - Mix 安裝的 rebar3 指令的覆寫路徑（預設值：~/.mix/rebar3）

• MIX_TARGET - 指定應使用的目標。請參閱 目標

• MIX_XDG - 要求 Mix 遵循 XDG 目錄規範，用於其主目錄和組態檔。由於向後相容性，此行為需要選擇加入。 MIX_HOME 的優先順序高於 MIX_XDG。如果未設定任何變數，將會使用預設目錄 ~/.mix

不打算儲存值的環境變數（基本上作為標記），應設定為 1 或 true，例如

$ MIX_DEBUG=1 mix compile