快轉到主要內容

Immich 繁體中文地理資料技術解析(二):資料處理流程

··4554 字·10 分鐘
目錄
immich-geodata-zh-tw - 本文屬於一個選集。
§ 3: 本文

系列上一篇:反向地理編碼是怎麼運作的拆解了 Immich 怎麼讀地理資料:啟動時把幾個純文字檔匯入 PostgreSQL,照片上傳時用最近鄰查詢找出地名。既然換掉檔案就能換掉顯示結果,剩下的問題就落在那份「更好的檔案」本身。

這篇拆解 immich-geodata-zh-tw 的資料處理流程:從各國官方圖資,到使用者下載的那包 release.tar.gz

兩條線
#

整套流程分成兩條線,各自負責不同的事:

  • extract:把某一個國家的官方圖資轉成中介 CSV。每個有專屬處理邏輯的國家各跑一次,彼此獨立。
  • release:把所有中介 CSV 併回 GeoNames 的資料,翻譯、打包成 release。六個階段依序執行。

extract 只服務有專屬處理器(handler)的國家,而要成為這種國家得同時滿足兩個條件:該國有可用的官方行政區圖資,而且專案裡寫了對應的處理邏輯去讀它。

其餘國家沒有 extract 這一步。但「沒有 extract」不等於「什麼都沒做」。發布出來的資料其實有三種精準度,差別在於該國經過了多少道處理。

最精準是走 extract 的那五個國家。 行政區名稱與代表點座標都由官方圖資重建,點位密度也跟著提高(臺灣細到村里層級)。代價是這個國家要有可用的官方圖資,而且得為它的資料格式寫一支處理器。

中間一層是經過 locationiq 反查的國家。 座標沿用 GeoNames 原本的點位,但每個點都會拿去反查一次,回傳的行政區層級會覆蓋掉原本的欄位。這一層的作用除了獲取中文的地名翻譯之外,也會用於修正「點的位置沒錯,但上游把它歸到錯的行政區、或名稱本身就寫錯」的情況。GeoNames 是全球資料庫,這類偏差並不少見。要走這一層,執行時得以 --country-code 指定該國並提供 API key。

基準層是其餘所有國家。 沒有被指定的國家就停在這裡,行政區歸屬與點位密度都維持 GeoNames 原樣,只有地名會在 translate 階段換成中文譯名。

換句話說,要更準的資料就得付出更多處理:什麼都不做就是基準層;願意花 API 額度反查,可以修掉上游的行政區錯誤;要再往上,就得找到該國的官方圖資,並為它寫專屬的處理邏輯。

release 執行時會檢查 meta_data/ 底下有沒有該國的中介 CSV,據此決定它走哪一條路。extract 的產物直接進版控,而官方圖資不常更新,所以發布時只要讀現成的 CSV,不必每次重跑各國的圖資處理。

immich-geodata-zh-tw 的資料處理流程:extract 把五個地區的官方圖資轉成中介 CSV,release 的六個階段將其併回 GeoNames 並打包成 release.tar.gz
兩條線:extract 產生中介 CSV,release 六階段併回 GeoNames 並打包

第一條線:extract
#

輸入是各國官方圖資,輸出是一份中介且固定格式的 CSV:

cargo run --release -- extract --country TW \
  --shapefile <NLSC 村里界圖資路徑>

輸出的 CSV 每一列是一個行政區單位,包含各層級名稱與計算好的代表座標。以臺灣為例,7,986 列,每列是一個村里。如此可以在 release 階段把它併回 GeoNames 的 cities500.txt,取代原本的點位與行政區欄位。

各國的差異全部集中在這一步:臺灣直接讀 NLSC 村里界圖資的三個欄位;日本要判斷普通市、政令指定都市與郡轄町村;南韓要取韓文維基的漢字表記;泰國與印尼要跑 Wikidata 查詢與 P131 隸屬驗證。這些處理邏輯是系列後續幾篇的主題,這裡先當作黑箱。

座標計算則是共通的:先投影到適合該國的座標系統算幾何中心,再轉回 WGS84。理由是經緯度上算中心點會失真,這點在臺灣篇會細講。

一個 handler 實際負責什麼
#

雖然各國差異很大,extract 內部其實是一條固定的管線,各國專屬的處理器只需要在管線中的特定位置提供對應的資料處理邏輯:

  • load_context:載入該國需要的對照表與快取。臺灣不需要,泰國與印尼要準備 Wikidata 查詢的環境。
  • apply_country_centroids:依該國指定的 centroid_pipeline 投影後計算中心點。臺灣走固定的 EPSG:3826,日韓走 dynamic UTM,泰國與印尼各自使用 Albers 投影。
  • rows_from_features:欄位對應與名稱決定。臺灣只讀 COUNTYNAMETOWNNAMEVILLNAME 三個欄位。

其餘部分,包含讀檔、解析 feature、排序、座標四捨五入、寫出統一欄位的 CSV,為所有國家共用。另外還有一個條件性的 split_parts(multipart 逐 part 拆列),目前只有印尼啟用。

extract 的內部管線:輸入圖資、讀檔解析 feature、load_context、split_parts、apply_country_centroids、rows_from_features、sort round write,最後輸出統一欄位的中介 CSV;其中 load_context、apply_country_centroids、rows_from_features 三個階段是各國專屬,split_parts 為條件性階段目前僅印尼啟用
灰色階段所有國家共用,珊瑚色階段是新增一個國家時要實作的部分

至於「哪些國家有 handler」,則寫在 Country enum 裡。Country::ALL 是唯一的事實來源,CLI 的清單由它導出,新增國家時不需要、也不能另外同步一份。

如果想要了解一個完整的 handler 長什麼樣子,可以參考臺灣篇從頭到尾走過一次。

第二條線:release 的六個階段
#

cargo run --release -- release \
  --locationiq-api-key "YOUR_API_KEY" \
  --country-code "US"

這一條指令會依序跑完六個階段:

階段做的事
cleanup清空並重建 output/ 目錄
prepare從 GeoNames 下載 cities500.txtadmin1CodesASCII.txt 等原始檔
enhance把各國中介 CSV 併入原始檔,配發 geoname_id,輸出 *_optimized.txt
locationiq沒有專屬處理邏輯的國家補行政區 metadata
translate套用官方譯名與中文別名,產出翻譯後的檔案
pack打包成 release.tar.gzrelease.zip

每個階段都可以單獨執行,也可以用 --pass-<stage> 跳過。

cleanup:冪等性的起點
#

這個步驟的作用很單純,即清空並重建 output/ 目錄,以確保每次執行都從乾淨狀態開始。

prepare:下載原料
#

GeoNames 抓三份原始檔:cities500.txt(人口 500 以上的聚落與行政中心,約 20 萬筆)、admin1CodesASCII.txt(一級行政區代碼對照名稱),以及 admin2Codes.txt(二級行政區,本專案不處理,只是保持檔案結構完整)。

已存在的檔案預設跳過,不重複下載。cities500.txt 解壓後有數百 MB,重跑流程時這一步的快取相當有感。

enhance:核心階段
#

這一步把兩件事併在一起:

  1. 併入各國資料:讀取 meta_data/ 底下的中介 CSV,把有專屬處理邏輯的國家(handler)資料寫進 admin1CodesASCII.txtcities500.txt,取代 GeoNames 原本那些點位。
  2. 配發 ID:新增的資料列不能跟既有的 geoname_id 撞號。

實際上, Immich 內部並不會驗證 geoname_id 的正確性亦不會記錄(只會記錄反解後的地名名稱),但是內部查詢時,城市需要與對應的 admin 1 配對,因次需要確保 ID 不會重複,並且配對。

為了做到這點,程式先算出目前資料中的全域最大 ID,再從最大值加一往後配發,admin1CodesASCII.txt 先取一段,cities500.txt 接著往下取。不寫死號碼區段的好處是,GeoNames 之後擴充資料時,新增的列也不會覆蓋到官方既有的點位。

geoname_id 配發示意:GeoNames 既有資料佔用到全域最大值,admin1CodesASCII 的新增列從最大值加一開始配發,cities500 的新增列接續其後,右側留白表示 GeoNames 之後擴充也不會撞號
新增列從當下的全域最大值往後配發,不寫死號碼區段

輸出是 cities500_optimized.txtadmin1CodesASCII_optimized.txt

locationiq:為指定的國家校正行政區
#

這一階段只處理執行時明確指定的國家,不是對全球資料通用。要納入的國家得在指令裡以 --country-code 列出(可以給多個),而且會自動排除掉已經有專屬處理器的那五個,因為它們的資料在 extract 就處理完了,沒必要再花 API 額度。

指定之後,該國每個地點的座標都會送去 LocationIQ 反查一次,回傳的行政區層級覆蓋原本 GeoNames 的欄位。這就是前面說的中間那層:座標不動,但修掉上游把點歸錯行政區、或名稱本身有誤的情況。沒被指定的國家完全不會經過這一步。

這裡是整條流程唯一會被外部服務卡住的地方。LocationIQ 有每日請求上限,而一個國家可能有上萬個地點要查,所以流程設計成可以中斷後續跑:

  • 查詢進度記錄在 meta_data/<國碼>.csv,已查過的座標會自動跳過。
  • 超過當日限制時,換 API key 或隔天重跑同一條指令即可。
  • 加上 --pass-cleanup 保留 output/ 既有的中間產物,省去重新下載與前處理。

前面說「階段可以單獨跳過」的設計,解決的就是這個問題。

translate:決定每個地名最後顯示什麼
#

有專屬處理器的國家在 extract 階段就定案了,不走這裡。其餘地名的中文可能來自好幾個地方,這一階段的工作是決定採用哪一個。

候選來源依序是:

  1. LocationIQ 反查回來的名稱。前一階段送出請求時就帶了 accept-language: zh,en,所以拿回來的行政區名稱本身可能已經是中文。
  2. 從 GeoNames 別名檔篩出的中文名prepare 下載的 alternateNamesV2.txt 收錄各語言別名,程式篩出中文條目並依 zh-Hantzh-TWzh-HKzhzh-Hanszh-CNzh-SG 排定優先序,產生 alternate_chinese_name.csv 供查表。這是每次執行重新產生的中間產物,不是人工維護的清單。
  3. cities500.txt 自帶的 alternatenames 欄位。上一項沒命中時的最後一道中文來源;同一個地點常有數十個別名,程式從中挑出中文的那個。

拿到候選之後,再由 國家教育研究院《外國地名譯名》 做最後一層裁決:信心足夠時直接覆寫既有名稱,信心不足就只在原本沒有中文名時補洞,遇到有疑慮的匹配則保留既有結果。三種情況在日誌裡分別統計,方便發布前檢查這一層改了多少東西。

全部落空的話就保留原文。冷門地點在 Immich 裡仍然可能顯示英文,這是刻意的。

translate 階段的決策流程:依序嘗試 LocationIQ 名稱、alternateNamesV2 篩出的中文、cities500 的 alternatenames 欄位,候選經 OpenCC 判定是否需要轉繁,再由國教院譯名裁決覆寫、補洞或保留既有,全部落空則保留原文
三個候選來源、OpenCC 判定與國教院裁決的先後關係

輸出是 cities500_translated.txtadmin1CodesASCII_translated.txt

OpenCC 不是拿來無腦轉繁的
#

由於在前面的步驟中所查詢得到的中文名稱可能包含簡體中文,因此我們會在這個步驟中儘量將中文都轉換成繁體中文。然而 不是拿到中文就轉,轉換前會先判定。程式同時準備了簡轉繁(s2t)與繁轉簡(t2s)兩個方向,靠來回轉換的結果比對來判斷一個字串目前是什麼:

  • text == t2s(text) → 這串字已經是簡體,才呼叫 s2t 轉成繁體
  • text == s2t(text) → 這串字已經是繁體,原樣保留、不動它

alternatenames 挑候選時也照這個規則:已經是繁體的優先直接採用,只有簡體候選才需要轉換。

之所以要在轉換之前先進行檢查,是因為無條件套用簡轉繁會改壞本來就正確的字。由於有些簡體中文可以同字但表示不同的意思,但繁體中文會使用兩個不同的字來表示不同的意思,這就會導致當這個詞被判斷成簡體字,無條件轉換時,會誤改一些本來就正確譯名(「里」變「裏」、「占」變「佔」這類過度轉換)。

pack:打包
#

把翻譯後的檔案、i18n-iso-countries/(國家名稱對照,見反向地理編碼是怎麼運作的)、LICENSENOTICE.md 整理成 release 目錄結構,寫入 geodata-date.txt,最後產出 release.tar.gzrelease.zip

這包就是安裝腳本 update_data.sh 下載的東西,目錄結構直接對應安裝時要放進 Immich 的位置。

不呼叫外部服務的驗證方式
#

這條流程的麻煩之處在於,它同時依賴網路下載與付費 API,不可能每次改動都跑一次完整流程來驗證。因此 CLI 提供兩種驗證模式:

dry-run:驗證 release 的階段編排,不下載資料也不呼叫 API。

cargo run -- release --dry-run \
  --locationiq-api-key "fixture" \
  --country-code "KR" "TH" \
  --batch-size 100 --locationiq-qps 2

--batch-size--locationiq-qpslocationiq 階段的節流參數(每批查詢筆數、每秒請求數)。dry-run 不會真的發出請求,帶上它們只是為了讓編排走過同一條路徑。

fixture mode:用本地的固定測資產生一份 smoke artifact,用來驗證 release 壓縮檔與 update_data.sh 需要的目錄結構是否正確。

cargo run -- release --fixture-mode \
  --pass-locationiq \
  --output-folder /tmp/rust-release-smoke

正式發布與 nightly 的 workflow 都走真實流程,但會先跑 fixture release smoke 當前置檢查。

這套階段劃分不是 Rust 版才有的

六階段從 v2 的 Python + Polars 時代就存在,v3.0.0 改寫為 Rust 之後階段名稱與職責大致沿用,主要差別在實作層。 其中比較有意思的一項是各國處理邏輯的註冊方式:Python 版用 registry 自動註冊,handler 類別定義好就會被掃到;Rust 版刻意改成 enum 與 static dispatch 的明確註冊,新增國家時必須同步修改 CLI 的國家解析與 dispatch。多寫那幾行,換掉的是「release 行為取決於 runtime 掃描到什麼」。發布流程產出的是所有使用者會下載的資料,這種地方的動態魔法出問題時很難查。


下一篇:五個地區,五種答案進入各國的處理邏輯:同一套流程之下,五個地區為什麼會得出五種不同的顯示策略。

參考資源
#

immich-geodata-zh-tw - 本文屬於一個選集。
§ 3: 本文

相關文章

Immich 繁體中文地理資料技術解析(一):反向地理編碼是怎麼運作的

··3450 字·7 分鐘
每當你上傳一張照片到 Immich,系統就會自動標註拍攝地點,例如「臺北市信義區」、「東京都澀谷區」。這背後並非雲端 API 的功勞,而是一套完全離線運行的反向地理編碼(Reverse Geocoding)系統。 也因為它是離線的,immich-geodata-zh-tw 這個專案才有存在的空間(實際安裝步驟見系列首篇的圖文安裝教學):Immich 從幾個純文字檔讀取地名,那麼換掉那幾個檔案,顯示出來的地名就會跟著換。 這篇是系列的技術篇第一篇,先把地基講清楚:Immich 查到一個地名時到底發生了什麼事、它讀的是哪幾個檔案,以及這個機制留下了哪些可以動手腳的空間。後續幾篇談的各國處理策略、翻譯與驗證,全部建立在這篇的基礎上。

Immich 地理編碼臺灣特化 - immich-geodata-zh-tw 專案介紹與使用教學

··4145 字·9 分鐘
本文介紹 immich-geodata-zh-tw 專案,這是一個專為繁體中文使用者打造的 Immich 反向地理編碼優化方案。除了針對臺灣進行深度的在地化處理(中文化、行政區層級補齊),支援範圍目前也涵蓋日本、南韓、泰國與印尼,其餘地區則補上臺灣慣用的中文譯名,並提供穩定的自動化更新機制。