# @digital-go-jp/abr-geocoder 中文文档 规范地址：https://npmcn.com/package/%40digital-go-jp/abr-geocoder/ 版本：2\.3\.1 npm 元数据更新时间：2026-09-12T10:36:35.857Z 中文译文更新时间：2026-11-12T08:35:12.330Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40digital-go-jp/abr-geocoder 原文对照：https://npmcn.com/package/%40digital-go-jp/abr-geocoder/?lang=original 项目主页：https://github.com/digital-go-jp/abr-geocoder 源码仓库：https://github.com/digital-go-jp/abr-geocoder 弃用说明：Deprecated\. v3 is on GitHub: https://github\.com/digital-go-jp/abr-geocoder ## 关键信息（来自 npm 元数据） - 包体积（解压后）：2.9 MB，696 个文件 - TypeScript 类型：未声明 - Node.js 要求：\>=20 - 运行依赖：17 个 - 首次发布：2023-10-20T04:35:00.937Z - 最新版本发布：2026-08-01T05:28:32.490Z - 近 30 天下载量：3031（2026-10-12 至 2026-11-10，npm 官方下载统计） - 已发布版本数：14（近 12 个月 2 个） ## 中文简介 デジタル庁:アドレス・ベース・レジストリを用いたジオコーダー ## 安装 ```sh npm install @digital-go-jp/abr-geocoder ``` 也可以使用：`pnpm add @digital-go-jp/abr-geocoder`、`yarn add @digital-go-jp/abr-geocoder`、`bun add @digital-go-jp/abr-geocoder` ## README # abr-geocoder (数字机构地址基站注册地理coder) - [日本語版](https://npmcn.com/package/%40digital-go-jp/abr-geocoder/README.ja.md) ## 从v2.2.1升级到2.3.0版本 - **错误修复**数字 : `abrg download -c ` 不再跳过 `mt_town_pos_pref**.csv` (镇主位置参考扩展为县级). - **重要**: 随着即将发布的"版本3","版本2.3.0"是"版本2"系列的最终发行. 将在第3版中作出后续的修改并增加特征,没有计划进一步支持第2版系列. ## 从v2.2升级到2.2.1版本 - 已更新以使用 DCAT 格式 API 下载数据集 . - **已知问题**编号: `abrg update-check` 命令尚未与新的 API 格式相容,也不会正常工作。 由于我们计划升级到第3版,第2版的支持尚未确定. ## 从v2.1升级到2.2版本 - 这个 `abrg serve` 命令被拆分为 `abrg serve start` 财务报告和审定财务报表 `abrg serve stop` 命令. ## 说明 将输入地址字符串与 [地址基登记](https://catalog.registries.digital.go.jp/rc/dataset/) 由数字局、日本政府维持,输出正常化地址串、城镇身份证、纬度和经度等。 它分析了日本国内地址的标记,吸收了变异,并且产出按照分级法使结果正常化. ![Image](https://lp.geocoder.address-br.digital.go.jp/assets/2024072820391722166771.png) ## 特征 - 以日本国内地址为目标的地理编码器. - 根据 [地址基登记](https://catalog.registries.digital.go.jp/rc/dataset/) 和等级. - 支助 `residence indication` 财务报告和审定财务报表 `partial number (lot number)`。 。 。 . - 使用 SQLite,允许在服务器内进行地理编码. - 通过多条线进行高速处理. - 支持六种输出格式: `csv`, (中文(简体) ), `json`, (中文(简体) ), `geojson`, (中文(简体) ), `ndjson`, (中文(简体) ), `ndgeojson`, (中文(简体) ), `simplified`。 。 。 . ## 使用大小写 - 可用作命令 : - 有标准输入/输出的管道. - 通过文件输入/输出 . - 可用作REST服务器. - 可用作节点.js库: - 支持单个请求和流. - 对由京都街名进行搜索的支持有限. ## 限制 - 无法通过地标搜索(例如著名的设施名称) . - 无法通过邮政编码搜索 . - 无法按字母查找( 英文标记) . ## 安装 - 全球安装 ```sh npm install -g @digital-go-jp/abr-geocoder abrg # Verify it runs ``` - 本地安装 ```sh npm install @digital-go-jp/abr-geocoder npm link abrg # Verify it runs ``` ## `abrg download` 命令 从中下载地理编码所需的数据集 [地址基登记](https://catalog.registries.digital.go.jp/rc/dataset/) 并使用 SQLite 构建数据库. ```sh abrg download [options] ``` - 指定要下载的区域 您可指定特定省或市建立本地化数据库,缩小数据规模并加快数据库建设. 使用 [国家地方政府法典](https://www.soumu.go.jp/denshijiti/code.html) 以指定区域。 分离多个有空间的区域. ```sh # Download data for Tokyo abrg download -c 130001 # Download data for Tokyo and Kanagawa abrg download -c 130001 140007 # Download data for Chiyoda ward abrg download -c 131016 ``` - 更改目录 可以更改目录来下载数据集文件并保存数据库. 默认是 `$HOME/.abr-geocoder`。 。 。 . ```sh abrg download -d (path to directory to save data) ``` - 隐藏进度栏 如果您指定了静态选项, 进度栏将不会显示 . ```sh abrg download --silent ``` - 显示调试信息 显示进程完成时花费的时间. ```sh abrg download --debug ``` ## `abrg update-check` 命令 检查数据更新 。 如果有本地数据,它会检查数据库所载各市镇的最新数据。 如果有新的数据,可以下载. ```sh abrg update-check [options] ``` - 预先具体说明是/否 如果有更新数据,可以预先说明是否继续下载. ```sh # Continue downloading abrg update-check --yes # Do not continue downloading abrg update-check --no ``` - 隐藏进度栏 如果您指定了静态选项, 进度栏将不会显示 . ```sh abrg update-check --silent ``` - 更改目录 指定保存数据库的目录。 默认是 `$HOME/.abr-geocoder`。 。 。 . ```sh abrg update-check -d (path to directory to save data) ``` - 显示调试信息 显示进程完成时花费的时间. ```sh abrg update-check --debug ``` ## `abrg` 命令 Geocode 输入地址字符串与数据库,输出正常化地址字符串,城镇ID,纬度,经度等. ```sh $ abrg [] [options] ``` - `` 指定如何将数据输入命令. - 如果指定了文件路径 指定的文本文件将被地理编码 。 每行输入一个地址. 示例 ```sh abrg ./sample.txt ``` 样本.txt: ``` 東京都千代田区紀尾井町1-3 // 1-3 Kioicho, Chiyoda-ku, Tokyo 東京都千代田区永田町1-10-1 // 1-10-1 Nagatacho, Chiyoda-ku, Tokyo ... 東京都千代田区永田町一丁目7番1号 // 1-7-1 Nagatacho, Chiyoda-ku, Tokyo ``` - 如果指定“ -” 从标准输入接收数据. 示例 ```sh echo "東京都千代田区紀尾井町1-3　東京ガーデンテラス紀尾井町 19階、20階" | abrg - ``` - `` 指定输出处理结果的地点。 如果省略,则输出为标准输出(stdout). - 如果指定了文件路径 将处理结果输出到指定的文件 。 产出格式基于\`格式'选项. 示例 ```sh abrg ./input.txt ./output.json ``` - 如果省略 如果省略,则输出为标准输出(stdout). 示例 ```sh cat ./sample.txt | abrg - | jq ``` - 更改产出格式 您可以用 `-f`, (中文(简体) ), `--format` 选项。 默认是 `json`。 。 。 . | 格式 | 说明 | | --- | --- | | (单位:千美元) | 以逗号分隔的csv格式产出结果 | | 简化 | 产出结果为带有限字段的逗号分隔式csv | | 乔森 | JSON格式的产出结果 | | 长子 | NDJSON格式的产出结果 | | 地质学 | GeoJSON格式的产出结果 | | 邓克森 | NDGeoJSON格式的产出结果 | - 指定通配符字符 您可以指定任意字符为通配符。 用于某些无法用utf-8表示的"老干"等字符被转换为"(黑圆)"的情况. 缺省是\`? ' . 示例 ```sh echo "東京都町●市森野2-2-22" | abrg - --fuzzy "●" ``` - 隐藏进度栏 如果您指定了静态选项, 进度栏将不会显示 . ```sh abrg ./input.txt ./output.txt --silent ``` - 更改目录 指定保存数据库的目录。 默认是 `$HOME/.abr-geocoder`。 。 。 . ```sh abrg ./input.txt ./output.txt -d (path to directory to save data) ``` - 显示调试信息 显示进程完成时花费的时间。 还输出每个表格中与输入地址串相匹配的主要关键信息. ```sh abrg ./input.txt ./output.txt --debug ``` - 更改地理编码目标 您可以用 `--target` 选项。 默认是 `all`。 。 。 . | 格式 | 说明 | | --- | --- | | 全部 | 搜索住址和包裹编号数据。 居住地址的结果优先. | | 住宿 | 只搜索住宅地址数据. | | 包裹 | 只搜索包裹编号数据. | | | ## `abrg serve start` 命令 启动地理编码器作为 REST API 服务器. ```sh abrg serve start [options] ``` 示例 ```sh curl http://localhost:3000/geocode?address=東京都千代田区紀尾井町1-3 ``` - 更改端口编号 更改 REST API 服务器的端口号 。 默认是 `3000`。 。 。 . ```sh abrg serve start -p 8080 ``` - 更改目录 指定保存数据库的目录。 默认是 `$HOME/.abr-geocoder`。 。 。 . ```sh abrg serve start -d (path to directory to save data) ``` - 请求参数 请求是通过HTTP/GET提出的. 下列参数可以指定: \*==================================================================================================== -?),又作"活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活 QQ地址 Y 地址字符串为地理编码. 必需参数 搜索目标(全部、住宅、包裹) QQ 格式 QQ 输出格式 一个作为通配符的单字符。 | ## `abrg serve stop` 命令 停止地理编码器作为REST API服务器. ```sh abrg serve stop ``` ## 常见问题 ### @digital-go-jp/abr-geocoder 是什么？ デジタル庁:アドレス・ベース・レジストリを用いたジオコーダー注意：该包已被作者标记为弃用——Deprecated\. v3 is on GitHub: https://github\.com/digital-go-jp/abr-geocoder ### 如何安装 @digital-go-jp/abr-geocoder？ 在项目目录运行 npm install @digital-go-jp/abr-geocoder，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 abrg，可以用 npx abrg 直接运行。 ### @digital-go-jp/abr-geocoder 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/digital-go-jp\_\_abr-geocoder 是否存在。 ### @digital-go-jp/abr-geocoder 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @digital-go-jp/abr-geocoder 可以商用吗？ @digital-go-jp/abr-geocoder 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @digital-go-jp/abr-geocoder 的下载量有多少？ 根据 npm 官方下载统计，@digital-go-jp/abr-geocoder 在 2026/10/12 – 2026/11/10 这 30 天内被下载 3,031 次，日均约 101 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @digital-go-jp/abr-geocoder 还在维护吗？ 最新版本 2\.3\.1 发布于 2026/08/01（3 个月前）；至今共发布 14 个版本，其中过去 12 个月发布了 2 个；首次发布于 2023/10/20。作者已将其标记为弃用，新项目建议寻找替代方案。