From 56edc7020036e73c97cbee2e84a94b1218a55151 Mon Sep 17 00:00:00 2001 From: shanhm1991 Date: Sun, 13 Oct 2024 08:43:54 +0800 Subject: [PATCH] pom.xml --- .github/workflows/maven.yml | 35 ++++ .gitignore | 7 +- LICENSE.txt | 202 ++++++++++++++++++ README.md | 163 +-------------- pom.xml | 404 +++++++++++++++++------------------- 5 files changed, 438 insertions(+), 373 deletions(-) create mode 100644 .github/workflows/maven.yml create mode 100644 LICENSE.txt diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 0000000..40f7b14 --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,35 @@ +# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: build + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + cache: maven + - name: Build with Maven + run: mvn -B package --file pom.xml + + # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive + #- name: Update dependency graph + # uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6 diff --git a/.gitignore b/.gitignore index 202f760..ec10551 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,3 @@ -.settings/ -.project -.classpath - +target/ .idea/ *.iml - -target/ \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 99c966a..5f2ee7b 100644 --- a/README.md +++ b/README.md @@ -1,164 +1,21 @@ -## spring-feign Http调用声明 +[![Build Status](https://github.com/cowave5/spring-feign/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/cowave5/spring-feign/actions) +![Static Badge](https://img.shields.io/badge/Java-17-brightgreen) +![Maven central](https://img.shields.io/badge/maven--central-2.7.1-brightgreen) +[![License](https://img.shields.io/badge/license-Apache--2.0-brightgreen)](http://www.apache.org/licenses/LICENSE-2.0.txt) -### 功能说明 +## spring-feign -- 提供了一个在Spring中使用Feign调用的声明注解，简单方便定制； +一个Http调用客户端，依赖netflix feign实现，方便在spring中声明 -#### 依赖 +- 依赖 ```xml com.cowave.commons spring-feign - 3.0.0 + 2.7.1 ``` -### 使用示例 - -#### 1. 指定调用服务的url - -> 对于Post的Body请求，默认会设置：Content-Type=application/json，如果手动设置了则以设置的为准 - -```java -@FeignClient(url = "${feign.demo.url}") -public interface DemoService { - - @RequestLine("GET /demo/api/v1/user/info/{id}") - Response userInfo(@Param("id") int id); - - @Headers({"Content-Type: application/json"}) - @RequestLine("POST /demo/api/v1/user/list") - Response> list(SysUser user); -} -``` - -#### 2. 指定调用服务的注册name - -> 如果使用服务注册中心，可以注入一个FeignServiceChooser实例，在Chooser中将name转换成对应服务的url，比如： - -```java -@RequiredArgsConstructor -@Component -public class CloudServiceChooser implements FeignServiceChooser { - - private final LoadBalancerClient balancerClient; - - @Override - public String choose(String name) { - ServiceInstance instance = balancerClient.choose(name.toUpperCase()); - if (instance == null) { - throw new IllegalArgumentException("service[" + name + "] not exist"); - } - return instance.getUri().toString(); - } -} -``` - -> 然后在调用声明时，就可以使用对应服务注册的name - -```java -@FeignClient(name = "service-demo") -public interface DemoService { - - @RequestLine("GET /demo/api/v1/user/info/{id}") - Response userInfo(@Param("id") int id); - - @Headers({"Content-Type: application/json"}) - @RequestLine("POST /demo/api/v1/user/list") - Response> list(SysUser user); -} -``` - -#### 3. 指定调用接口的url - -> 如果调用的服务url不能在初始化时指定，需要在具体接口调用时才确定，那么可以使用@Host来标记，其优先级高于@FeignClient中的name和url； - -> @Options可以在方法上指定调用的超时属性，其优先级也高于@FeignClient中的设置，这样方便针对不同的方法设置超时； - -> 这里声明的返回类型是HttpResponse，主要是针对外部服务的调用（通用Http规范，但是没有遵从我们的约定）； - -```java -@FeignClient -public interface NmsService { - - // 比如 url = http://ip:port - @Options(connectTimeoutMillis = 1000, readTimeoutMillis = 1000) - @RequestLine("GET /api/nms/svn_rcst/rcst_authentication?ids={ids}") - HttpResponse list(@Host String url, @Param("ids") List ids); -} -``` - -#### 4. 请求设置 RequestInterceptor - -> 如果需要对请求做一些设置，可以实现一个RequestInterceptor，比如常见的在请求头中设置认证Token或requestId信息 - -```java -public class FeignInterceptor implements RequestInterceptor { - - @Override - public void apply(RequestTemplate requestTemplate) { - String accessId = Access.id(); - String authorization = Access.token(); - if(StringUtils.isBlank(accessId)) { - accessId = newAccessId(); - } - if(StringUtils.isBlank(authorization)) { - authorization = newAuthorization(); - } - requestTemplate.header("accessId", accessId); - requestTemplate.header("Authorization", authorization); - } -} -``` - -#### 5. 响应Decoder设置 - -> 可以指定decoder，比如对于我们约定的Response响应结构，可以使用ResponseDecoder，这样就可以直接获取结果类型，不用再自己判断响应码（如果Http.status或Response.code不是200，则抛异常） - -```java :UserService -@FeignClient(name = "service-demo", decoder = ResponseDecoder.class) -public interface DemoService { - - @RequestLine("GET /demo/api/v1/user/info/{id}") - SysUser userInfo(@Param("id") int id); - - @Headers({"Content-Type: application/json"}) - @RequestLine("POST /demo/api/v1/user/list") - List list(SysUser user); -} -``` - -#### 6. 下载上传支持 - -> 下载支持比较简单，只需使用`HttpResponse`接收就行，不过注意要自己关闭Stream； - -> 对于上传只做了有限的支持，固定设置：Content-Type=multipart/form-data; -> 使用@MultipartForm来标记表单数据，仅支持类型：`Map`； -> 使用@MultipartFile来标记文件，仅支持类型：InputStream、File、MultipartFile、byte[]； - -```java -@FeignClient(url = "http://localhost:8080") -public interface DemoService { - - @RequestLine("GET /demo/api/download") - HttpResponse download(); - - @RequestLine("POST /demo/api/upload") - HttpResponse upload(@MultipartForm Map map, @MultipartFile(fileName = "xx.sql") InputStream inputStream); -} -``` - -#### 7. Https支持 - -> Feign.Client原本就支持Https连接的设置，可以指定SSLSocketFactory和HostnameVerifier，这里做的也只是在@FeignClient声明中暴露了这两个设置，比如: - -```java -@FeignClient(url = "https://localhost:8080", - sslSocketFactory = DemoSslSocketFactory.class, hostnameVerifier = DemoHostnameVerifier.class) -public interface FeignService { - - @RequestLine("GET /demo/api/v1/user/info/{id}") - Response userInfo(@Param("id") int id); -} -``` +- 使用说明：[wiki](https://github.com/cowave5/spring-feign/wiki/%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E) +- 问题建议：[issues](https://github.com/cowave5/spring-feign/issues) diff --git a/pom.xml b/pom.xml index f9a19b2..ee3c956 100644 --- a/pom.xml +++ b/pom.xml @@ -1,227 +1,203 @@ - 4.0.0 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + 4.0.0 - com.cowave.commons - spring-feign - 2.8.0 - jar + com.cowave.commons + spring-feign + 2.7.1 + jar - spring-feign - A simple http calling tool, adapted based on netflix-feign - https://gitlab.cowave.com/commons/tools/spring-feign + spring-feign + A simple http client, based on netflix feign + https://github.com/cowave5/spring-feign.git - - - The Apache Software License, Version 2.0 - http://www.apache.org/licenses/LICENSE-2.0.txt - repo - - + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + repo + + - - github - https://gitlab.cowave.com/commons/tools/spring-feign/issues - + + github + https://github.com/cowave5/spring-feign/issues + - - scm:git:https://gitlab.cowave.com/commons/tools/spring-feign.git - scm:git:https://gitlab.cowave.com/commons/tools/spring-feign.git - https://gitlab.cowave.com/commons/tools/spring-feign - + + https://github.com/cowave5/spring-feign + scm:git:https://github.com/cowave5/spring-feign.git + scm:git:https://github.com/cowave5/spring-feign.git + - - - shanhuiming - shanhuiming@cowave.com - https://shanhm1991.github.io/ - - + + + shanhm1991 + shanhm1991@163.com + + - - UTF-8 - UTF-8 - UTF-8 - + + UTF-8 + UTF-8 + UTF-8 + - - src/main/java - - - src/main/resources - - META-INF/** - - - - - - org.apache.maven.plugins - maven-compiler-plugin - 3.8.1 - - 17 - 17 - UTF-8 - - - - org.apache.maven.plugins - maven-release-plugin - 3.0.0 - - forked-path - false - -spring-feign-release - - - - org.codehaus.mojo - cobertura-maven-plugin - 2.7 - - - html - xml - - - - - - org.apache.maven.plugins - maven-source-plugin - 3.2.0 - - true - - - - - jar - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - 3.0.0 - true - - - bundle-sources - package - - jar - - - - - 1024 - UTF-8 - protected - true - false - none - - - - + + src/main/java + + + src/main/resources + + META-INF/** + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.1 + + 17 + 17 + UTF-8 + + + + org.apache.maven.plugins + maven-source-plugin + 3.2.0 + + true + + + + source-generate + package + + jar + + + + + + - - - cowave - releases - http://10.64.4.74:8081/repository/maven-releases/ - true - - - cowave - snapshots - http://10.64.4.74:8081/repository/maven-snapshots/ - true - - + + + release + + + + org.apache.maven.plugins + maven-gpg-plugin + 3.2.7 + + + sign-artifacts + verify + + sign + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.5.0 + true + + + javadocs-generate + package + + jar + + + -Xdoclint:none + -Xdoclint:none + + + + + + org.sonatype.central + central-publishing-maven-plugin + 0.6.0 + true + + central + + + + + + - - - release - - - - org.apache.maven.plugins - maven-gpg-plugin - 1.6 - - - sign-artifacts - verify - - sign - - - - - - - - + + + central + https://central.sonatype.com/ + + - - - com.netflix.feign - feign-core - 8.18.0 - - - com.netflix.feign - feign-jackson - 8.18.0 - - - org.reflections - reflections - 0.9.10 - - - com.github.pagehelper - pagehelper - 6.1.0 - - - org.springframework.boot - spring-boot-starter-jdbc - - - - - com.baomidou - mybatis-plus-extension - 3.5.4.1 - - - org.springframework.boot - spring-boot-starter-web - 2.7.0 - provided - - - com.fasterxml.jackson.core - jackson-databind - 2.6.4 - provided - - - org.slf4j - slf4j-api - 1.7.30 - provided - - - org.projectlombok - lombok - 1.18.24 - provided - - + + + com.netflix.feign + feign-core + 8.18.0 + + + com.netflix.feign + feign-jackson + 8.18.0 + + + org.reflections + reflections + 0.9.10 + + + com.github.pagehelper + pagehelper + 6.1.0 + + + org.springframework.boot + spring-boot-starter-jdbc + + + + + com.baomidou + mybatis-plus-extension + 3.5.4.1 + + + org.springframework.boot + spring-boot-starter-web + 2.7.0 + provided + + + com.fasterxml.jackson.core + jackson-databind + 2.6.4 + provided + + + org.slf4j + slf4j-api + 1.7.30 + provided + + + org.projectlombok + lombok + 1.18.24 + provided + +