# administrative-api

**Repository Path**: chengfenggui/administrative-api

## Basic Information

- **Project Name**: administrative-api
- **Description**: 行政区划工具包
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2022-01-12
- **Last Updated**: 2023-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# administrative-region-api

行政区划的api



## 1.安装

mvn org.apache.maven.plugins:maven-install-plugin:2.5.2:install-file -Dfile=<path-to-file>

## 2.使用

##### 1.导包

```xml
<dependency>
	<groupId>org.example</groupId>
	<artifactId>administrative-region-api</artifactId>
	<version>1.0</version>
</dependency>
```

##### 2.配置

1.Application.Class扫包(注意：在启动类上加会覆盖原配置)

```java
@ComponentScan(basePackages = {"com.vit.zhao"})
```

方案二：另起配置类，例：AdministratConfig.Class（加@Configuration和@ComponentScan(basePackages = {"com.vit.zhao"})）

2.application.yml

```yml
administrative:
  pattern: locality
  sourcePath: E:/data.json
```

参数说明：

pattern是数据源加载模式，默认locality，加载本地数据源。database是从数据库读取文件，此功能还未完成

sourcePath是本地数据路径，项目里有默认的数据，目前是宁夏回族自治区的数据，如果想用自己的数据，把路径配在这里就可以了（ps：数据必须用Navicat导出）

##### 3.调用

方式一：将AdministrativeService注入 然后调用方法

```java
 @Autowired
 private AdministrativeService administrativeService;

/**
     * 通过code获取行政区划数据
     * @param code 行政区划编码
     * @return AdministrativeModel
     */
    public Result<?> getAdministrativeByCode(String code){
        AdministrativeModel administrativeByCode = administrativeService.getAdministrativeByCode(code);
        return Result.OK(administrativeByCode);
    }
```

方式二：直接通过AdministrativePort对象调用

```java
/**
     * 查询上级行政区划
     * @param code 行政区划编码
     * @return AdministrativeModel
     */
    public Result<?> getAdministrativeByUp(String code){
        AdministrativeModel administrativeByUp = AdministrativePort.example().getAdministrativeByUp(code);
        return Result.OK(administrativeByUp);
    }
```