前言
該篇文章分享如何將Python Web
服務融入到Spring Cloud微服務體系中,並調用其服務,Python Web框架用的是Flask
方案
Sidecar
+ Flask
,在這里,我們會使用Sidecar
將Python
接口注冊到SpringCloud
中,將Python
接口當作Java
接口進行調用(通過SpringCloud
去調用Sidecar
,然后通過Sidecar
去轉發我們的程序請求)
Sidecar
是SpringCloud
提供的一個可將第三方的rest
接口集成到SpringCloud
中的工具
Python服務
manage.py
import json
from flask import Flask, Response, request, make_response, jsonify
app = Flask(__name__)
@app.route("/health")
def health():
result = {'status': 'UP'}
return Response(json.dumps(result), mimetype='application/json')
@app.route("/getUser")
def getUser():
result = {'username': 'python', 'password': 'python'}
return Response(json.dumps(result), mimetype='application/json')
@app.errorhandler(404)
def not_found(error):
return make_response(jsonify({'error': 'Not found'}), 404)
if __name__ == "__main__":
app.run(host="0.0.0.0", port=3000)
大致說下上述代碼,Python
服務監聽3000
端口,health
方法用於給Sidecar
提供健康接口,用於實時向Sidecar
提供自己的健康狀態,getUser
是Python
向外界提供的服務
- 運行方式
python manage.py runserver
sidecar-server工程
- 添加依賴
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-netflix-sidecar</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
SidecarApplication.java
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.sidecar.EnableSidecar;
@EnableSidecar
@SpringBootApplication
public class SidecarApplication {
public static void main(String[] args) {
SpringApplication.run(SidecarApplication.class, args);
}
}
application.yml
spring:
profiles:
active: "dev"
application:
name: demo-sidecar
sidecar:
port: 3000
health-uri: http://localhost:${sidecar.port}/health
ribbon:
ConnectTimeout: 50000
ReadTimeout: 50000
hystrix:
command:
default:
execution:
isolation:
thread:
timeoutInMilliseconds: 10000
server:
port: 8326
eureka:
client:
healthcheck:
enabled: true
service-url:
defaultZone: http://${registry.host:localhost}:${registry.port:8761}/eureka/
registry:
host: localhost
port: 31091
大致說下上述代碼,main
方法要使用@EnableSidecar
注解,sidecar port
代表監聽Python
運行的端口,server port
代表Sidecar
運行的端口,spring application name
代表Sidecar
的服務名,sidecar health-uri
是Python
健康接口,指向python的健康服務
服務調用 - consumer-server工程
調用方式一 : RestTemplate
ConsumerApplication.java
import org.springframework.boot.SpringApplication;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
@SpringCloudApplication
public class ConsumerApplication {
@Bean
@LoadBalanced
RestTemplate restTemplate() {
return new RestTemplate();
}
public static void main(String[] args) {
SpringApplication.run(ConsumerApplication.class, args);
}
}
application.yml
spring:
profiles:
active: "dev"
application:
name: consumer-server
server:
port: 8325
eureka:
client:
healthcheck:
enabled: true
service-url:
defaultZone: http://${registry.host:localhost}:${registry.port:8761}/eureka/
---
spring:
profiles: dev
registry:
host: localhost
port: 31091
RestTemplateController.java
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
@RestController
public class RestTemplateController {
@Autowired
private RestTemplate restTemplate;
@RequestMapping("/java-user")
public String JavaUser() {
return "{'username': 'java', 'password': 'java'}" ;
}
@RequestMapping("/python-user")
public String PythonUser() {
return restTemplate.getForEntity("http://sidecar-server/getUser", String.class).getBody();
// return restTemplate.getForEntity("http://localhost:3000/getUser", String.class).getBody();
}
}
- 這里做下說明,
@LoadBalanced
用於開啟負載均衡,在這里有兩種調用方式,使用和不使用@LoadBalanced
- 使用
@LoadBalanced
注解后,RestTemplate
可以直接調用服務名
@Bean
@LoadBalanced
RestTemplate restTemplate() {
return new RestTemplate();
}
++++++++++++++++++++++++++++++
return restTemplate.getForEntity("http://sidecar-server/getUser", String.class).getBody();
- 不使用
@LoadBalanced
注解,RestTemplate
調用的就是固定的IP+PORT
@Bean
// @LoadBalanced
RestTemplate restTemplate() {
return new RestTemplate();
}
++++++++++++++++++++++++++++++
return restTemplate.getForEntity("http://localhost:3000/getUser", String.class).getBody();
- 服務的啟動順序:
Python
服務,注冊中心,sidecar-server
工程,consumer-server
工程 - 運行結果
調用方式二: Feign
SidecarController.java
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import com.coisini.consumer.client.SidecarAPIClient;
@RestController
public class SidecarController {
private SidecarAPIClient sidecarAPIClient;
@Autowired
public SidecarController(SidecarAPIClient sidecarAPIClient) {
this.sidecarAPIClient = sidecarAPIClient;
}
@GetMapping("/getUser")
public Object getUser() {
return this.sidecarAPIClient.getUser();
}
}
SidecarAPIClient.java
import com.coisini.consumer.config.FeignConfigure;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
@FeignClient(name="sidecar-server", configuration = FeignConfigure.class)
public interface SidecarAPIClient {
@GetMapping("/getUser")
Object getUser();
}
FeignConfigure.java
import feign.Logger;
import feign.codec.Encoder;
import feign.form.spring.SpringFormEncoder;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.web.HttpMessageConverters;
import org.springframework.cloud.netflix.feign.EnableFeignClients;
import org.springframework.cloud.netflix.feign.support.SpringEncoder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableFeignClients(basePackages = "com.coisini")
public class FeignConfigure {
@Bean
Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
@Autowired
private ObjectFactory<HttpMessageConverters> messageConverters;
@Bean
public Encoder feignFormEncoder() {
return new SpringFormEncoder(new SpringEncoder(messageConverters));
}
}
- 服務的啟動順序:
Python
服務,注冊中心,sidecar-server
工程,consumer-server
工程 - 調用結果
至此,已完成微服務調用Python Web服務
Sidecar總結
Sidecar
是一個用於監聽非JVM應用程序(可以是Python
或者Node
或者Php
等等)的一個工具,通過Sidecar
可以實現Java
和第三方應用程序的雙向交互- 第三方應用程序必須要實現一個接口,實時向
Sidecar
報告自己的狀態,告訴Sidecar
自己還在運行着。 Sidecar
應用程序必須和第三方應用程序運行在同一台電腦上,也就是說他們之間是localhost
,不能是IP
訪問
Demo下載
GitHub:SpringCloud 使用Sidecar整合Python Flask
Gitee:SpringCloud 使用Sidecar整合Python Flask
參考博客
SpringCloud 整合Python 感謝大佬
end