概述
介绍了 api 的各种写法之后,下面介绍构建 api 时与数据库连接的方式。
注 下面使用的工程的完整代码已经公开在: http://git.oschina.net/wangyubin/phoenix-api
ecto 简介
ecto 其实是独立于 phoenix framework 的,它是 elixir 语言实现的用来访问数据库的框架,类似于 ORM 但是和传统的 ORM 又有些不一样。 可以这么理解,它是利用了 elixir 语言的动态性和函数式的特性,参考了传统的 ORM 的优势后而开发的新一代数据库访问层。
ecto 的四个主要组件
- Ecto.Repo 数据库包装器, 通过它可以执行数据库的增删改查, 通过它配置数据库连接
- Ecto.Schema 这是 ORM 的核心,定义了操作对象和底层数据库表之间的映射
- Ecto.Changeset 这是 Ecto 的一个创新的地方,在 Changeset 中,可以定义校验数据层合法性的方法,在真正写入数据库之前,对数据进行校验
- Ecto.Query 以 elixir 语法编写的查询,可以避免 SQL 注入等常见问题
ecto 使用示例
创建示例工程
defp deps do
[
{:postgrex, ">= 0.0.0"},
{:ecto, "~> 2.0.0"}
]
end
def application do
[applications: [:logger, :postgrex, :ecto]]
end
数据库连接配置
# vi config/config.exs
config :ecto_sample, ecto_repos: [EctoSample.Repo]
config :ecto_sample, EctoSample.Repo,
adapter: Ecto.Adapters.Postgres,
database: "ecto_sample",
username: "iotalab",
password: "iotalab",
hostname: "localhost"
配置好数据库连接之后,就可以在命令行下创建数据库了
创建 model 和 migration 代码
首先,通过命令行创建一个用来生成表的的 users module。
$ mix ecto.gen.migration users
这个命令会在 priv/repo/migrations 下自动生成 migration 脚本,只不过脚本是空的。 下面先创建 users 表的内容,然后填充 migration 脚本的内容
# vi lib/ecto_models.ex
defmodule EctoSample.User do
use Ecto.Schema
schema "users" do
field :name, :string
field :password, :string
field :age, :integer
timestamps
end
end
# vi priv/repo/migrations/20160912131700_users.exs 这个文件是由上一条命令产生的
defmodule EctoSample.Repo.Migrations.Users do
use Ecto.Migration
def up do
create table(:users) do
add :name, :string
add :password, :string
add :age, :integer
timestamps
end
end
def down do
drop table(:users)
end
end
创建数据库表
创建命令非常简单
使用示例
创建了一个简单的表之后,就可以在命令行下测试是否可以操作数据库了。 下面演示了新增一个 user 和 删除一个 user 的过程。
$ iex -S mix
Erlang/OTP 19 [erts-8.0.2] [source] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:false] [dtrace]
Interactive Elixir (1.3.2) - press Ctrl+C to exit (type h() ENTER for help)
iex(1)> u = %EctoSample.User{name: "wyb", password: "passwd", age: 33}
%EctoSample.User{__meta__: #Ecto.Schema.Metadata<:built, "users">, age: 33,
id: nil, inserted_at: nil, name: "wyb", password: "passwd", updated_at: nil}
iex(2)> EctoSample.Repo.insert(u)
22:09:51.433 [debug] QUERY OK db=4.4ms
INSERT INTO "users" ("age","name","password","inserted_at","updated_at") VALUES ($1,$2,$3,$4,$5) RETURNING "id" [33, "wyb", "passwd", {{2016, 9, 12}, {14, 9, 51, 0}}, {{2016, 9, 12}, {14, 9, 51, 0}}]
{:ok,
%EctoSample.User{__meta__: #Ecto.Schema.Metadata<:loaded, "users">, age: 33,
id: 3, inserted_at: #Ecto.DateTime<2016-09-12 14:09:51>, name: "wyb",
password: "passwd", updated_at: #Ecto.DateTime<2016-09-12 14:09:51>}}
iex(3)> u = %EctoSample.User{id: 3}
%EctoSample.User{__meta__: #Ecto.Schema.Metadata<:built, "users">, age: nil,
id: 3, inserted_at: nil, name: nil, password: nil, updated_at: nil}
iex(4)> EctoSample.Repo.delete(u)
22