Geocoder 技术文档

1. 安装指南

Geocoder 是一个 Ruby 的完整地理编码解决方案。为了使用 Geocoder，您需要确保您的系统已经安装了以下依赖项：

• Ruby 版本：2.1 或更高版本，以及 JRuby。
• 数据库：MySQL、PostgreSQL、SQLite 或 MongoDB。
• 如果您使用的是 Rails 框架，需要确保您的 Rails 版本是 5.x、6.x 或 7.x。

安装 Geocoder：

gem install geocoder

如果您在 Rails 应用中使用 Geocoder，需要在 Gemfile 中添加 geocoder 并执行 bundle install。

gem 'geocoder'

然后，在您的模型中配置 Geocoder。

2. 项目使用说明

Geocoder 提供了以下基本功能：

• 正向和反向地理编码。
• IP 地址地理编码。
• 支持全球 40 多个 API。
• 具有缓存等性能增强功能。
• 与 ActiveRecord 和 Mongoid 集成。
• 基本的地理空间查询：搜索指定半径（或矩形、或环）内的位置。

基本搜索

使用 Geocoder 搜索地址以获取其经纬度坐标：

results = Geocoder.search("北京")
results.first.coordinates
# => [纬度, 经度]

反过来，给定经纬度坐标也可以找到地址：

results = Geocoder.search([纬度, 经度])
results.first.address
# => "具体的地址"

您还可以查找 IP 地址的位置：

results = Geocoder.search("IP地址")
results.first.coordinates
# => [纬度, 经度]
results.first.country
# => "国家"

地理编码对象

要自动对您的对象进行地理编码，请遵循以下步骤：

1. 您的模型必须提供一个返回要地理编码的地址的方法。这可以是一个属性，也可以是一个返回不同属性组合（例如城市、州和国家）的字符串的方法。
2. 您的模型必须有一种方法来存储经纬度坐标。对于 ActiveRecord，添加两个类型为 float 或 decimal 的属性/列，分别命名为 latitude 和 longitude。对于 MongoDB，使用名为 coordinates 的类型为 Array 的单个字段（即 field :coordinates, type: Array）。
3. 在您的模型中，告诉 Geocoder 对象的地址位置：

geocoded_by :address

这将添加一个 geocode 方法，您可以通过回调调用该方法：

after_validation :geocode

反向地理编码（给定经纬度坐标，查找地址）与此类似：

reverse_geocoded_by :latitude, :longitude
after_validation :reverse_geocode

对于 MongoDB，您需要包含必要的模块：

include Geocoder::Model::Mongoid

使用 Rails 之外的环境

如果要在非 Rails 环境中使用 Geocoder 与 ActiveRecord（如 Sinatra 或 Padrino），需要在调用 Geocoder 方法之前在模型中添加以下代码：

extend Geocoder::Model::ActiveRecord

3. 项目 API 使用文档

Geocoder 的配置选项包括：

• Street address geocoding service (默认为 :nominatim)
• IP address geocoding service (默认为 :ipinfo_io)
• API key 设置
• 请求超时设置
• 默认单位（公里或英里）
• 缓存设置

以下是一个示例配置：

Geocoder.configure(
  lookup: :yandex,
  ip_lookup: :maxmind,
  api_key: "...",
  timeout: 5,
  units: :km,
  cache: Redis.new,
  cache_options: {
    expiration: 1.day,
    prefix: "another_key:"
  }
)

更多配置选项请参考 lib/geocoder/configuration.rb。

4. 项目安装方式

请参考上述安装指南安装 Geocoder。确保您的环境满足所有依赖项的要求，并在 Rails 应用中正确配置 Geocoder。