feat: GeocodingX增加save方法，以方便生成自定义的dat字典文件 #180 (#181)

Co-authored-by: 何翀彬 <[email protected]>

Author: blvyoucan

src/main/java/org/bitlap/geocoding/GeocodingX.kt

@@ -109,4 +109,8 @@ open class GeocodingX(val ctx: Context) {
         indexBuilder.indexRegions(listOf(region), replace)
         return this
     }
+
+    fun save(path: String) {
+        ctx.persister.save(path)
+    }
 }

src/main/java/org/bitlap/geocoding/core/AddressPersister.kt

@@ -25,4 +25,9 @@ interface AddressPersister {
      * 新增一个region信息
      */
     fun addRegionEntity(entity: RegionEntity)
+
+    /**
+     * 保存一个新的dat文件
+     */
+    fun save(path: String)
 }

src/main/java/org/bitlap/geocoding/core/RegionCache.kt

@@ -1,6 +1,6 @@
-package org.bitlap.geocoding.core;
+package org.bitlap.geocoding.core
 
-import org.bitlap.geocoding.model.RegionEntity;
+import org.bitlap.geocoding.model.RegionEntity
 
 /**
  * Desc: 获取 region entity 的抽象接口
@@ -26,4 +26,9 @@ interface RegionCache {
      * 新增一个region信息
      */
     fun addRegionEntity(entity: RegionEntity)
+
+    /**
+     * 保存一个新的dat文件
+     */
+    fun save(path: String)
 }

src/main/java/org/bitlap/geocoding/core/impl/DefaultAddressPersister.kt

@@ -37,4 +37,10 @@ open class DefaultAddressPersister (
         regionCache.addRegionEntity(entity)
     }
 
+    /**
+     * 保存一个新的dat文件
+     */
+    override fun save(path: String) {
+        regionCache.save(path)
+    }
 }

src/main/java/org/bitlap/geocoding/core/impl/DefaultRegoinCache.kt

@@ -5,8 +5,12 @@ import org.bitlap.geocoding.core.RegionCache
 import org.bitlap.geocoding.model.RegionEntity
 import org.bitlap.geocoding.model.RegionType
 import java.io.ByteArrayInputStream
-import java.util.Base64
+import java.io.ByteArrayOutputStream
+import java.io.FileOutputStream
+import java.util.*
 import java.util.zip.GZIPInputStream
+import java.util.zip.GZIPOutputStream
+import kotlin.text.Charsets.UTF_8
 
 /**
  * Desc: 默认 [RegionEntity] 获取的缓存类
@@ -76,4 +80,16 @@ open class DefaultRegionCache(dataClassPath: String) : RegionCache {
         this.REGION_CACHE[entity.id] = entity
         this.REGION_CACHE[entity.parentId]?.children?.add(entity)
     }
+
+    /**
+     * 保存一个新的dat文件
+     */
+    override fun save(path: String) {
+        val gzip = ByteArrayOutputStream()
+        GZIPOutputStream(gzip, 8192).use { gzipos ->
+            gzipos.write(Gson().toJson(regions, RegionEntity::class.java).toByteArray(UTF_8))
+        }
+        val dat = Base64.getMimeEncoder().encode(gzip.toByteArray())
+        ByteArrayInputStream(dat).copyTo(FileOutputStream(path), 8192)
+    }
 }

src/test/java/org/bitlap/geocoding/TestCustomDatSave.kt

@@ -0,0 +1,64 @@
+package org.bitlap.geocoding
+
+import org.bitlap.geocoding.model.Address
+import org.bitlap.geocoding.model.RegionType
+import org.junit.Test
+import kotlin.test.assertEquals
+
+/**
+ * Desc: 测试保存自定义文件
+ * Mail: [email protected]
+ * Created by hechongbin
+ * Date: 2023/6/7
+ */
+class TestCustomDatSave {
+
+    @Test
+    fun saveAndNomalizing() {
+        val geocoding = GeocodingX("region_2021.dat")
+        val addrss = "浙江省杭州市临平区经济开发区新颜路22号501D"
+
+        // 未添加自定义地区"临平区"
+        assertEquals(
+            geocoding.normalizing(addrss),
+            Address(
+                330000000000, "浙江省",
+                330100000000, "杭州市",
+                330110000000, "余杭区",
+                330110001000, "临平街道",
+                null, null,
+                null, null,
+                null, null,
+                "501",
+                "区经济开发区新颜路22号D"
+            )
+        )
+
+        // 添加自定义地区"临平区"
+        geocoding.addRegionEntry(330113000000, 330100000000, "临平区", RegionType.District, "", true)
+
+        val addNew = Address(
+            330000000000, "浙江省",
+            330100000000, "杭州市",
+            330113000000, "临平区",
+            null, null,
+            null, null,
+            null, null,
+            "新颜路", "22号",
+            "501",
+            "D"
+        )
+
+        assertEquals(geocoding.normalizing(addrss), addNew)
+
+        // 添加后"临平区"后保存自定义字典文件
+        val filename = "mydata.dat"
+        val filePath = "${this.javaClass.classLoader.getResource("").path}/$filename"
+        geocoding.save(filePath)
+
+        // 读取添加了"临平区"的自定义字典文件
+        val myGeocoding = GeocodingX(filename)
+        assertEquals(myGeocoding.normalizing(addrss), addNew)
+    }
+
+}