首页
/ Geocoder 技术文档

Geocoder 技术文档

2024-12-23 08:34:39作者:鲍丁臣Ursa

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 的属性/列,分别命名为 latitudelongitude。对于 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。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8