# Feign Generator Plugin

**Repository Path**: fxsun/feign-generator-plugin

## Basic Information

- **Project Name**: Feign Generator Plugin
- **Description**: 自动生成 feign 接口工具。
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-10-18
- **Last Updated**: 2025-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Feign-Generator

## 介绍
自动生成 feign 接口工具。


## 编译

```shell
mvn install
```



## 添加插件

```xml
<!-- 生成 Feign 类-->
<plugin>
    <groupId>com.wuhdev</groupId>
    <artifactId>feign-generator-plugin</artifactId>
    <version>1.0.4</version>
    <configuration>
        <!-- 配置扫描 controller 的基础包名-->
        <scanPackage>${project.groupId}.${project.artifactId}.adapter.api</scanPackage>
        <!-- 配置代码输出包名-->
        <outputPackage>${project.groupId}.${project.artifactId}.idl.service</outputPackage>
        <!-- FeignClient 注解上面的 URL 从配置读取的配置名称-->
        <urlPropertyName>params.service.${project.artifactId}</urlPropertyName>
        <!-- 保存到 Git 仓库地址，不填则保存到本地-->
        <gitUrl>git@git.xxx.com:group/project.git</gitUrl>
        <!-- 保存到 Git 时作为顶级目录名，非必填-->
        <moduleName>${project.artifactId}</moduleName>
        <!-- 仅对符合条件的分支处理-->
        <includeBranch>^feature-.*</includeBranch>
    </configuration>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
</plugin>
```





## 参数说明

| 参数             | 说明                                                         | 默认值            |
| ---------------- | ------------------------------------------------------------ | ----------------- |
| scanPackage      | 配置扫描 controller 的基础包名                                 | ${project.groupId}.${project.artifactId} |
| outputPackage    | 配置代码输出包名。                             | ${project.groupId}.${project.artifactId}.idl.service |
| urlPropertyName  | FeignClient 注解上面的 URL 从配置读取的配置名称 | params.service.${project.artifactId}                 |
| gitUrl  | 保存到 Git 仓库地址，不填则保存到本地 |                  |
| moduleName  | 保存到 Git 时作为顶级目录名，非必填 |                  |



## Maven编译工程

```shell
mvn clean package
```

## 生成代码
```
target/generated-feign-classes
```