有没有办法在 Rails 的 Postgresql 记录中强制执行 JSON 字段的模式？

Question

我正在涉足 Postgres 中的 json 字段。所以我使用 activerecord 进行大多数验证。但是，我想添加一个 json 字段并能够对其进行验证。有没有一种干净的方法可以做到这一点？我想我总是可以创建自己的验证函数，但似乎有更好的方法可以利用 json 模式？有人成功了吗？

Answer 1

您可以使用json-schema gem：

schema = {
  "type" => "object",
  "required" => ["a"],
  "properties" => {
    "a" => {"type" => "integer"}
  }
}
JSON::Validator.validate(schema, { "a" => 5 }) 
# => true
JSON::Validator.validate(schema, { "a" => "five" })
# => false 

请注意，这是广义上的验证器 - 不是可以直接与 ActiveRecord 一起使用的验证器。

Writing a custom ActiveModel validator 不过很简单：

require "json-schema"
class SchemaValidator < ActiveModel::EachValidator

  def validate_each(record, attribute, value)
    # Looks for a JSON schema as a class constant
    c = "#{attribute.upcase}_SCHEMA"
    begin 
      schema = record.class.const_get(c)
    rescue NameError => e
      # re-raise exception with a more descriptive message
      raise( 
        $!, 
        "Expected #{record.class.name}::#{c} to declare a JSON Schema for #{attribute}", 
        $!.backtrace
      )
    end
    unless JSON::Validator.validate(schema, value)
      record.errors.add(attribute, 'does not comply to JSON Schema')
    end
  end
end

然后我们可以这样使用它：

class Thing < ActiveRecord::Base
  FOO_SCHEMA = {
    "type" => "object",
    "required" => ["a"],
    "properties" => {
      "a" => {"type" => "integer"}
    }
  }

  validates :foo, schema: true
end

Answer 2

您还可以在数据库级别检查 json。据我所知，PostgreSQL 中有两个库可以验证 JSON：

• Postgres JSON Schema用SQL写的
• is_jsonb_valid 用 C 编写。（免责声明我已经编写了库）

一旦你安装了其中一个，你可以这样做：

ALTER TABLE my_table ADD CONSTRAINT data_is_valid CHECK (validate_json_schema('{/*your schema here */}', my_json));

如果您使用的是 Postgres JSON 模式，并且：

ALTER TABLE my_table ADD CONSTRAINT data_is_valid CHECK (is_jsonb_valid('{/*your schema here */}', my_json));

如果您使用的是 is_jsonb_valid。