逆ジオコーディング、ザックリ言うと緯度経度といった座標から住所を割り出す仕組み、前回は必要な情報をデータベースに入れる前にクエリファイルを準備するところまでやりました。
ayano.hateblo.jp
今回は実際にAPI サーバーを実装して動かすところまでをやってみます。
あらかじめVisual Studio 2022と、Dockerを構成するのでDocker Desktopを導入しておきます。名前空間 を省いています。お試しになりたい方はご注意ください。
今回はASP.NET Core Web API プロジェクトを使います。
追加情報の画面では「Docker を有効にする」にチェックを入れます。Docker OSについてはとりあえずLinux で。HTTPS 用の構成」はお好みにあわせて…ですがだいたい入れたままの方がいいかと思います。
プロジェクトを作成すると自動でコンテナが作成されます。実行ボタンが「Docker」になっているので、このまま押せばコンテナ上にビルドが展開され、SwaggerのAPI リファレンスページが出てきます。
では次にプロジェクトの準備をします。
Microsoft .EntityFrameworkCorePomelo.EntityFrameworkCore.MySql
Pomelo.EntityFrameworkCore.Mysql .NetTopologySuite
たぶんこのパッケージを入れれば依存関係で勝手に他2つも入りそうです
次にデータベースから読み取るテーブルの定義を作ります。適当なところにコードファイルを追加します。クラス名およびファイル名は「DbAddress」としておきます。
using Microsoft.EntityFrameworkCore;
using NetTopologySuite.Geometries;
using System.ComponentModel.DataAnnotations.Schema;
public abstract class DbAddress
{
[Column("gid" )]
public int Id { get; init; }
[Column("pref_name" )]
public string ? Prefecture { get; init; }
[Column("gst_name" )]
public string ? County { get; init; }
[Column("css_name" )]
public string ? City { get; init; }
[Column("s_name" )]
public string ? Aza { get; init; }
[Column("geom" )]
public MultiPolygon? Geom { get; init; }
}
テーブル定義が抽象クラスになっているのには理由があって、同じテーブル定義は一対一である必要があるっぽく、都道 府県ぜんぶ同じテーブル定義だとしてもそれぞれクラスを作らないといけなかったためです。都道 府県のクラスをずらっと作ります。プロパティ名がテーブル名と一致していればOKです。
public class Tokyo : DbAddress { }
あんまし作ってもめんどくさいだけなので、とりあえずお試しに一個だけ東京都だけ用意します。
public record AddressModel
{
< summary >
</ summary >
public string ? Prefecture { get; init; }
< summary >
</ summary >
public string ? Municipal { get; init; }
< summary >
</ summary >
public string ? Aza { get; init; }
}
最低限この3つだけで充分かと思います。郡と市区町村を混ぜて返すようにしているので、分けたい場合はもう一つ「County」とか作っておくとよいかもしれません。
さらに、これを含むレスポンスデータとして返すためのモデルクラスも作っておきます。「ResponseModel」と名付けます。エス トで受け取った緯度と経度をそのまま返すのと、複数の住所が取得できる可能性があるので*1 IEnumerableとして列挙できるようにしておきました。
public class ResponseModel
{
public double Latitude { get; init; }
public double Longitude { get; init; }
public IEnumerable<AddressModel> Addresses { get; init; }
}
次にデータベースとやりとりするクラスを作成します。Microsoft .EntityFrameworkCore.DbContextを継承した新しいクラスは「AddressDbContext」とでもしておきましょうか。
#nullable disable
using Microsoft.EntityFrameworkCore;
public class AddressDbContext : DbContext
{
public AddressDbContext(DbContextOptions<AddressDbContext> options)
: base (options)
{
}
public DbSet<Tokyo> Tokyo { get; init; }
}
続いては、いよいよAPI としてコントローラーを作成します。一般的にはここで「新規スキャフォールディングアイテム」として追加することが多いですが、まだDockerでMariaDB を動かしたりしていないのと、だいたい何がしたいかはわかっているので、シンプルにクラスを作ります。
「DbAddress」クラスで定義した「Geom」プロパティがここで活躍します。これを使って座標から必要な情報を受け取ります。
まずは「Contains」メソッド。Listでも見覚えがあると思います。「特定の座標が範囲内に含まれているか」がわかります。図にするとこんな感じかなと
Containsの例 P1は範囲AとB両方に含まれているので、例えばP1を対象にして探索すると両方ともtrueになるので両方が結果として返ってきます。
public class Area
{
public MultiPolygon Geom { get; init; }
}
DbSet<Area> area;
NetTopologySuite.Geometries.Point p1 = new (35 , 140 );
var result = area.Where(w => w.Geom.Contains(p1));
一方で、P2とP3はそれぞれAとBにしか含まれていないので、探索すると片方だけが結果として返ってきます。
NetTopologySuite.Geometries.Point p2 = new (36 , 138 );
NetTopologySuite.Geometries.Point p2 = new (37 , 139 );
var result2 = area.Where(w => w.Geom.Contains(p2));
var result3 = area.Where(w => w.Geom.Contains(p3));
ここでは記載してませんが、仮にどこにも含まれない点P4があるとしたら、結果は空です。
次に「Distance」メソッドです。こちらは「特定の座標との距離」がわかります。図にするとこんな感じかなと
Distanceの例 主に点でやりとりする際には便利かと思います。距離の近い何点かをピックアップするなどとか。
public class Area
{
public MultiPolygon Geom { get; init; }
}
DbSet<Area> area;
NetTopologySuite.Geometries.Point p1 = new (35 , 140 );
NetTopologySuite.Geometries.Point p2 = new (32 , 141 );
NetTopologySuite.Geometries.Point p2 = new (33 , 139 );
var result1 = area.Select(s => s.Geom.Distance(p1));
var result2 = p1.Distance(p2);
var result3 = p2.Distance(p3);
これらを踏まえて、コントローラーは以下のようにしました。
using Microsoft.AspNetCore.Mvc;
using NetTopologySuite.Geometries;
[ApiController]
[Route("geo" )]
public class ReverseGeocodingController : ControllerBase
{
AddressDbContext dbContext;
public ReverseGeocodingController(AddressDbContext context)
{
this .dbContext = context;
}
[HttpGet]
public ResponseModel Get(double latitude, double longitude)
{
var point = new Point(longitude, latitude);
var result = this .dbContext.Tokyo
.Where(w => w.Geom != null && w.Geom.Contains(point))
.Select(s => new AddressModel
{
Prefecture = s.Prefecture,
Municipal = s.County + s.City,
Aza = s.Aza
});
return new ResponseModel
{
Latitude = latitude,
Longitude = longitude,
Addresses = result
};
}
}
ここまでできたら、まわりの整備をおこないます。json にデータベースへの接続のための設定を書き込んでおきます。
"ConnectionStrings ": {
"DbContext ": "Server=db;Database=reverse_geocoding;User=[データベースにアクセスするためのユーザー名];Password=[パスワード];CharSet=utf8mb4; "
}
ユーザー名とパスワードはあとで別の設定でも使います
Program.cs に以下を追記します。どこでもいいですが、builderのインスタンス を使うのでそのあたりに書いておくといいと思います。
var mariaDbVersion = new MariaDbServerVersion(new Version(15 , 1 ));
var connectionString = builder.Configuration.GetConnectionString("DbContext" );
builder.Services.AddDbContext<AddressDbContext>(
options => options.UseMySql(connectionString, mariaDbVersion,
o => o.UseNetTopologySuite()
.EnableRetryOnFailure()));
MariaDB を扱うためにDocker Composeを使います。ざっくり言えば複数のコンテナを一元的に管理するためのツールです。エクスプローラ ーのプロジェクトを右クリックし、「追加」から「コンテナー オーケストレーターのサポート」を選びます。*2 なので、そのままOKを押します。次に出るウインドウではターゲットOSはLinux でOKです。
そうすると、ソリューションエクスプローラ ーには「docker-compose」という新しい項目が追加され、「docker-compose.yml」が用意されていますので、そこにMariaDB を使うよう追記します。
services :
db :
container_name : db
image : mariadb:latest
restart : always
ports :
- 3306:3306
command :
- mysqld
- --character-set-server=utf8mb4
- --collation-server=utf8mb4_unicode_ci
- --max_allowed_packet=1G
environment :
- MARIADB_ROOT_PASSWORD=[rootが使うパスワード]
- MARIADB_DATABASE=reverse_geocoding
- MARIADB_USER=[データベースにアクセスするためのユーザー名]
- MARIADB_PASSWORD=[パスワード]
- TZ=Asia/Tokyo
- LANG=C.UTF-8
volumes :
- "./Sql/Init:/docker-entrypoint-initdb.d"
appsetings.json に記述したUserとPasswordはそれぞれMARIADB _USERとMARIADB _PASSWORDでも同じものを使うようにします。ディレクト リとそのマウント先です。こうすることで、docker-compose側に置いたSql /Initディレクト リが、コンテナ側のdocker-entrypoint-initdb.dとリンクします。MariaDB はdocker-entrypoint-initdb.dディレクト リにあるsql ファイルを見てテーブルを自動で作成してくれます。
次に docker-compose プロジェクトにSql ディレクト リと、その下にInitディレクト リを作成します。sql 」になっているかと思います。ファイル名で特段問題になることはないので、このままでも、わかりやすく「Tokyo.sql 」などにするのもどちらでもよいと思います*3 。
ここまで終わればあとは実行します。実行ボタンが「Docker Compose」になっていることを確認して押します。API リファレンスページが出てきます。
Table Op Msg_type Msg_text
reverse_geocoding.Tokyo analyze status OK
クエリファイルの末尾に「ANALYZE TABLE `Tokyo`;」が入っていたことで、終わったことを確認することができるのはちょっと便利でした。
ここまでできればもうあとは試すことができます。SwaggerのAPI リファレンスページに「ReverseGeocoding」の項目と「GET | /geo」が追加されているのがわかるかと思います。Googleマップ などから拾ってきます。
35.681074, 139.766607 そうするとレスポンスが返ってきます。うまくいけば、以下のように「東京都千代田区 丸の内１丁目」が得られるかと思います。
{
"latitude ": 35.681074 ,
"longitude ": 139.766607 ,
"addresses ": [
{
"prefecture ": "東京都 ",
"municipal ": "千代田区 ",
"aza ": "丸の内１丁目 "
}
]
}
やりましたね！できました。
public class DbRoadName
{
[Column("gid" )]
public int Id { get; init; }
[Column("road_name" )]
public string ? RoadName { get; init; }
[Column("road_num" )]
public string ? RoadNumber { get; init; }
[Column("popular_road_name" )]
public string ? PopularRoadName { get; init; }
[Column("geom" )]
public MultiPolygon? Geom { get; init; }
}
この定義とマッピング するDbContextはAddressDbContextに一緒に入れちゃおうと思います。なので、AddressDbContextクラスに以下のプロパティを追記します。
public DbSet<DbRoadName> ExpressWay { get; init; }
テーブル名とプロパティ名が一致していればOKです。今回はテーブル名がExpressWayなのでこうしています。
public class RoadModel
{
public string Name { get; init; }
public string RoadNumber { get; init; }
public string ? PopularName { get; init; }
}
public class ResponseModel
{
public IEnumerable<RoadModel> Roads { get; init; }
}
コントローラーのGetメソッドにも、道路名を取得するためのロジックを記入します。住所と同じくポリゴンなのでContainsでだいたい良いかと思います。
public ResponseModel Get(double latitude, double longitude)
{
var roadNames = this .dbContext.ExpressWay
.Where(w => w.Geom != null && w.Geom.Contains(point))
.Select(s => new RoadModel
{
Name = s.RoadName ?? string .Empty,
PopularName = s.PopularRoadName ?? string .Empty,
RoadNumber = s.RoadNumber ?? string .Empty
});
return new ResponseModel
{
Latitude = latitude,
Longitude = longitude,
Addresses = result,
Roads = roadNames
};
あとはdocker-composeプロジェクトの「Sql /Init」ディレクト リに作った道路情報が入ったクエリファイルを追加します。MariaDB の初期化処理が走らないので、docker-composeプロジェクトを「クリーン」してあげると、Composeされたコンテナが消し飛びます。これを利用して初期化して立て直します。
35.702681, 139.775734 高速道路の位置を外すと道路名が空配列になります。
35.702632, 139.776227 これで動くものがついにできました！道府県 を追加する際は、前回の記事に書いたとおりテーブル1個に寄せるか、都道 府県単位のテーブルを用意して、まず座標から大まかな位置を特定してから必要なテーブルにアクセスする方式を採るとよいと思います。後者の方が更新しやすいかも。
最後に外のウェブサーバーに公開する方法です。Azureを使わず、ASP.NET Coreが動かせる環境にしたVPS でホストするようにしました。VPS にアップロードしました。ディレクト リに「docker-compose.yml」を追加します。
hnys.jp
これにちょっと手を加えるとこんな感じ。
version : '3.4'
services :
db :
container_name : db
image : mariadb:latest
restart : always
ports :
- 3306:3306
command :
- mysqld
- --character-set-server=utf8mb4
- --collation-server=utf8mb4_unicode_ci
- --max_allowed_packet=1G
environment :
- MARIADB_ROOT_PASSWORD=[rootが使うパスワード]
- MARIADB_DATABASE=reverse_geocoding
- MARIADB_USER=[データベースにアクセスするためのユーザー名]
- MARIADB_PASSWORD=[パスワード]
- TZ=Asia/Tokyo
- LANG=C.UTF-8
volumes :
- "./Sql/Init:/docker-entrypoint-initdb.d"
myapp :
container_name : myapp
image : mcr.microsoft.com/dotnet/aspnet:6.0
restart : always
ports :
- 5080:80
- 5443:443
environment :
ConnectionStrings__DbContext : [ appsettings.jsonに書いたのを上書きしたいときに使う。使わなければ削除]
volumes :
- ./app:/myapp
entrypoint : [ "dotnet" , "/myapp/myapp.exe" ]
depends_on :
- db
開発中に使ったのとちょっと違うのは、ASP.NET のコンテナを作る部分が具体的に書かれているところです。これは似たようなものは「docker-compose.override.yml」にも書かれています。
できあがったら、VPS にもろもろをアップロードします。SSH などでアクセスして、docker-compose.ymlのあるディレクト リに移動し「docker-compose up -d」すればコンテナが立ちあがって無事に起動するはずです。Microsoft Docsあたりが参考になるかと思います。
docs.microsoft.com
Program.csで条件式「app.Environment.IsDevelopment()」を外していなければ、発行後はSwaggerのAPI リファレンスが表示されないので、
http://[addr]/geo?latitude=35.702681&longitude=139.775734
でアクセスすれば結果が返ってくるかと思います。
がんばって端折ったつもりがかなり長くなってしまいました。最初は難しそうだなあと思って敬遠していた逆ジオコーディングも、情報さえ手に入ってしまえば割と面倒なことなく作れることがわかりました。*4 なのですぐに陳腐化してしまうところが難しいところかなと思います。
ちなみに、デジタル庁が「アドレス・ベース・レジストリ 」として住所情報のデータベース化を進めています。現状は各住所を点座標で得られるのみにとどまっていますが、今後ポリゴンデータも整備されそうなので注視していこうと思います。
www.digital.go.jp
まああまりこういうのを自分で作らなきゃいけないシーンってあまりないとは思いますが、何かの参考になれば幸いです。
最後に、このサービスを使った自前アプリのスクショを貼って終わりにします。
いつかはこれをストアに公開したいなーって（画像の状態はエミュレーター を使った上で一部加工しています）
![ソニー / 広角単焦点レンズ / APS-C / Sonnar T* E 24mm F1.8 ZA / ツァイスレンズ / デジタル一眼カメラα[Eマウント]用 純正レンズ / SEL24F18Z](https://m.media-amazon.com/images/I/31guXCe2VjL._SL500_.jpg "ソニー / 広角単焦点レンズ / APS-C / Sonnar T* E 24mm F1.8 ZA / ツァイスレンズ / デジタル一眼カメラα[Eマウント]用 純正レンズ / SEL24F18Z")
![ソニー / マクロ / APS-C / E 30mm F3.5 Macro / デジタル一眼カメラα[Eマウント]用 純正レンズ / SEL30M35](https://m.media-amazon.com/images/I/517TrDTE9qL._SL500_.jpg "ソニー / マクロ / APS-C / E 30mm F3.5 Macro / デジタル一眼カメラα[Eマウント]用 純正レンズ / SEL30M35")
