# vision-sdk-java-demo-springboot

**Repository Path**: zhoujiayaoo/vision-sdk-java-demo-springboot

## Basic Information

- **Project Name**: vision-sdk-java-demo-springboot
- **Description**: vision-sdk-java-demo-springboot
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-20
- **Last Updated**: 2025-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vision-sdk-java说明文档v1.0.0

[TOC]

## 说明

> * 版本：v1.0.0



## 参考工程demo

**gitee仓库地址**：https://gitee.com/zhoujiayaoo/vision-sdk-java-demo-springboot



## 使用步骤

### 引入jar包

将jar包放置在项目根路径下lib文件夹下，参考目录结构



![image-20250520215213795](https://jiayao-bucket.oss-cn-guangzhou.aliyuncs.com/typora-images/20220601/image-20250520215213795.png)

> 注意：jar包位置需要与pom文件配置匹配



### pom文件核心配置

```xml
<!-- 其他配置省略 -->


	<dependencies>
		<!-- Vision SDK -->
        <dependency>
            <groupId>com.zhoujiayao</groupId>
            <artifactId>vision-sdk-java</artifactId>
            <version>1.0.0</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/lib/vision-sdk-java-1.0.0.jar</systemPath>
        </dependency>
    </dependencies>


	<build>
        <finalName>vision-sdk-java-demo-springboot</finalName> <!-- 固定输出的jar名 -->

        <plugins>
            <!-- 编译插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>

            <!-- Spring Boot 打包插件 -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>
                <configuration>
                    <mainClass>com.zhoujiayao.vision.VisionSDKJavaDemoSpringbootApplication</mainClass> <!-- 入口类 -->
                    <!-- 关键：把 system scope 依赖也一起打包 -->
                    <includeSystemScope>true</includeSystemScope>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal> <!-- 关键目标：重新打包成可运行 jar -->
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

<!-- 其他配置省略 -->
```



### 调用sdk接口

参考测试类

```java
public class MainTest {

    public static void main(String[] args) {
        // 读取项目根目录下的这张图片
        String imagePath = StrUtil.format("{}/images/1.jpg", System.getProperty("user.dir"));

        // 初始化
        VDetectionApi vDetectionApi = VDetectionApi.getInstance();
        VDetectionInitConf initConf = new VDetectionInitConf();
        boolean init = vDetectionApi.init(new VDetectionInitConf());

        // 检测图片
        VDetectionResult vDetectionResult = vDetectionApi.detectByImagePath(imagePath);
        log.info(JSONUtil.toJsonPrettyStr(vDetectionResult));
    }
}
```



## 接口文档

### vDetectionApi.init() 初始化接口

接口说明：用于sdk初始化、设置默认参数等。

> 示例代码：

```java
// 初始化
VDetectionApi vDetectionApi = VDetectionApi.getInstance();
VDetectionInitConf initConf = new VDetectionInitConf();
boolean init = vDetectionApi.init(new VDetectionInitConf());
```



### vDetectionApi.detectByImagePath() 车牌图片检测接口

接口说明：传入图片绝对路径，识别车牌

```java
// 检测图片
VDetectionResult vDetectionResult = vDetectionApi.detectByImagePath(imagePath);
log.info(JSONUtil.toJsonPrettyStr(vDetectionResult));
```

>  请求参数：

| 参数名称  | 数据类型 | 说明             |
| --------- | -------- | ---------------- |
| imagePath | String   | 图片文件绝对路径 |



>  响应参数：

| 参数名称        | 数据类型          | 说明                                           |
| --------------- | ----------------- | ---------------------------------------------- |
| detectionTime   | String            | 接口检测时间                                   |
| plateInfoList   | List\<PlateInfo\> | 车牌信息列表                                   |
| ++ plateNo      | String            | 车牌号                                         |
| ++ plateColor   | String            | 车牌颜色                                       |
| ++ width        | Float             | 车牌号宽度                                     |
| ++ height       | Float             | 车牌号高度                                     |
| ++ KeyPointList | List\<KeyPoint\>  | 车牌关键点列表（分别为左上、右上、右下、左下） |
| ++ ++ x         | Float             | 关键点横坐标                                   |
| ++ ++ y         | Float             | 关键点纵坐标                                   |



>  响应参数示例

```json
{
    "detectionTime": 131,
    "plateInfoList": [
        {
            "plateNo": "皖C-10031",
            "plateColor": "蓝色",
            "width": 2321,
            "height": 3431,
            "KeyPointList": [
                {
                    "x": 1323.34,
                    "y": 23123
                },
                {
                    "x": 1323.34,
                    "y": 23123
                },
                {
                    "x": 1323.34,
                    "y": 23123
                },
                {
                    "x": 1323.34,
                    "y": 23123
                }
            ]
        },
        {
            "plateNo": "皖C-10032",
            "plateColor": "白色",
            "width": 2321,
            "height": 3431,
            "KeyPointList": [
                {
                    "x": 1323.34,
                    "y": 23123
                },
                {
                    "x": 1323.34,
                    "y": 23123
                },
                {
                    "x": 1323.34,
                    "y": 23123
                },
                {
                    "x": 1323.34,
                    "y": 23123
                }
            ]
        }
    ]
}
```