SpringCloud整合php、python示例

比眉伴天荒 2022-05-23 01:53 269阅读 0赞

# SpringCloud整合php、python示例 #

代码已上传至： [https://github.com/KeoZmy/SpringCloudDemo.git][https_github.com_KeoZmy_SpringCloudDemo.git] ，博客中没有写到网关 zuul，但是git中已上传

## 前言 ##

最近一直在花时间研究微服务，各种开源组件组合一个framework到最后决定用springcloud这样成熟的framework。不得不说，springcloud确实很强大，还有Pivotal和Netfix是其强大的后盾与技术输出。最后还是选用了springcloud的netfix作为核心的开发。

springcloud中的sidecar是出于netfix中prana的启发，正如官方reference所说：

Do you have non-jvm languages you want to take advantage of Eureka, Ribbon and Config Server? The Spring Cloud Netflix Sidecar was inspired by Netflix Prana. It includes a simple http api to get all of the instances (ie host and port) for a given service. You can also proxy service calls through an embedded Zuul proxy which gets its route entries from Eureka. The Spring Cloud Config Server can be accessed directly via host lookup or through the Zuul Proxy. The non-jvm app should implement a health check so the Sidecar can report to eureka if the app is up or down

你是否有非jvm语言应用程序需要使用Eureka, Ribbon和Config Server的功能? Spring Cloud Netflix Sidecar 受 Netflix Prana 启发. 它包含一个简单的HTTP API去获取所有注册的实例信息(包括host和port信息). 你也可以通过依赖Eureka的嵌入式Zuul代理器代理服务调用. The Spring Cloud Config Server可以通过host查找 或Zuul代理直接进入. 非JVM应用程序提供健康检查实现即可让Sidecar向eureka同步应用程序up还是down.

简单的说，一个非jvm程序，如：php、python等，想要注册到eureka，但是应用都是一堆别的语言写的，那我应该如何实现呢？Sidecar的原理就是侦听该应用所运行的端口，然后检测该程序的运行状态，官方的描述会更形象一些：

![ilU73lu.png][]

## 实现 ##

本文主要是参考官方给出结合python的例子，示例了一个springcloud结合php、python的例子。

### php准备 ###

先准备一下php的环境，详见：

[使用WAMP快速搭建PHP Web开发环境][WAMP_PHP Web]

(ps:我没有做过php的相关开发，只是最近参与公司项目的重构，里面以java代码为主但是也有python、php的模块，自己快速搭建了一个php的demo做测试，如果你是专业的php developer你当然可以选择你自己的方式)

我的wamp服务器www目录：

![q7K3c0r.png][]

health.json就是非JVM应用程序提供模仿SpringBoot健康检查接口的可访问的uri. 它应该返回一个json文档类似如下:

`{"status":"UP"}`

*  1
 *  2

by the way，我把服务器的端口改成了3000，默认的是80

[如何修改wamp默认80端口][wamp_80]

### python准备（python大神请随意） ###

这边主要是写了一个python程序模拟web应用的运行，这个应用占用的端口为5680

import httplib
    
    from twisted.web import server, resource
    from twisted.internet import reactor, endpoints
    
    class Health(resource.Resource):
        isLeaf = True
    
        def render_GET(self, request):
         request.setHeader("content-type", "application/json")
         return '{"status":"UP"}\n'
    
    class Fortune(resource.Resource):
        isLeaf = True
    
    def render_GET(self, request):
        conn = httplib.HTTPConnection('localhost', 5678)
        conn.request("GET", "/fortunes")
        res = conn.getresponse()
        fortune = res.read()
        request.setHeader("content-type", "text/plain")
        return fortune
    
    
    root = resource.Resource()
    root.putChild('health', Health())   
    root.putChild('', Fortune())
    endpoints.serverFromString(reactor, "tcp:5680").listen(server.Site(root))
    reactor.run()

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21
 *  22
 *  23
 *  24
 *  25
 *  26
 *  27
 *  28
 *  29
 *  30

### Eureka ###

创建一个springboot程序，修改pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>
     <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>org.test</groupId>
    <artifactId>eureka</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    
    <name>eureka</name>
    <description>Demo project for Spring Boot</description>
    
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.2.5.RELEASE</version>
        <relativePath/> 
    </parent>
    
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
            <version>RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>RELEASE</version>
        </dependency>
    </dependencies>
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-parent</artifactId>
                <version>Angel.SR3</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
     </project>

*  1
 *  2
 *  3
 *  4
 *  5
 *  6
 *  7
 *  8
 *  9
 *  10
 *  11
 *  12
 *  13
 *  14
 *  15
 *  16
 *  17
 *  18
 *  19
 *  20
 *  21
 *  22
 *  23
 *  24
 *  25
 *  26
 *  27
 *  28
 *  29
 *  30
 *  31
 *  32
 *  33
 *  34
 *  35
 *  36
 *  37
 *  38
 *  39
 *  40
 *  41
 *  42
 *  43
 *  44
 *  45
 *  46
 *  47
 *  48
 *  49
 *  50
 *  51
 *  52
 *  53
 *  54
 *  55
 *  56
 *  57
 *  58
 *  59
 *  60
 *  61
 *  62
 *  63
 *  64
 *  65
 *  66
 *  67
 *  68
 *  69
 *  70
 *  71
 *  72
 *  73
 *  74
 *  75
 *  76
 *  77
 *  78

修改application.properties配置文件

server.port=8761
    eureka.client.fetch-registry=false
    eureka.client.register-with-eureka=false

*  1
 *  2
 *  3
 *  4

最后，我们在EurekaApplication中添加注解`@EnableEurekaServer`，开启服务的注册中心

![h3H7XIB.png][]

项目目录结构如下：

![tWIMLjS.png][]

### Configserver ###

创建一个springboot程序，修改pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>org.test</groupId>
    <artifactId>configserver</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    
    <name>configserver</name>
    <description>Demo project for Spring Boot</description>
    
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.2.5.RELEASE</version>
        <relativePath/> 
    </parent>
    
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.security</groupId>
                    <artifactId>spring-security-rsa</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
            <version>RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>RELEASE</version>
        </dependency>
    </dependencies>
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-parent</artifactId>
                <version>Angel.SR3</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
     </project>

修改application.properties配置文件:

server.port=8888
     spring.cloud.config.server.git.uri=https://github.com/spencergibb/oscon-config-repo

*  1
 *  2
 *  3

这里还有一个配置文件bootstrap.properties：

server.port=5678
    sidecar.port=3000
    sidecar.health-uri=http://localhost:${sidecar.port}/phpTest/health.json

*  1
 *  2
 *  3
 *  4

项目目录如下：

![Hblz6iN.png][]

### sidecar for php ###

开始编写一个为php应用对接的sidecar程序

同样，这是一个springboot程序，我们先改写pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>org.test</groupId>
    <artifactId>sidecar</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    
    <name>sidecar</name>
    <description>Demo project for Spring Boot</description>
    
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.2.5.RELEASE</version>
        <relativePath/> 
    </parent>
    
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</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>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test</artifactId>
            <version>RELEASE</version>
        </dependency>
    </dependencies>
    
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-parent</artifactId>
                <version>Angel.SR3</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
    </project>

然后在程序中开启@EnableSidecar

![ovJJGFH.png][]

最后，关键性的一步，我们改写application.properties文件

server.port=5678    
    sidecar.port=3000
    sidecar.health-uri=http://localhost:${sidecar.port}/phpTest/health.json

*  1
 *  2
 *  3
 *  4

`server.port=5678` 指定了这个sidecar运行时所占用的端口

`sidecar.port=3000` 指定了sidecar监听非jvm应用程序的端口，就是我们的php程序所挂载的服务器，之前我已经把服务器端口改成3000了

`sidecar.health-uri=http://localhost:${sidecar.port}/phpTest/health.json`指定了php程序返回给sidecar的健康指标状态，我这里是通过文件的返回，当然你也可以通过RESTAPI，如果程序没有正常挂起，sidecar自然不能进行健康监测访问health.json（或者health方法），拿不到`up`，所以在注册中心则会显示一个`douwn`的状态，表示程序没有正常挂起，这就是sidecar的思想。

项目结构：

![Yjjg950.png][]

### sidecar for python ###

创建一个为python对接的sidecar，步骤和上面创建为php的如出一辙，只是配置文件有些许的不同

server.port=5688
    sidecar.port=5680
    sidecar.health-uri=http://localhost:${sidecar.port}/health

*  1
 *  2
 *  3
 *  4

开头我们所准备的python应用占用的就是5680端口，这里拿到健康状态的监测是通过RESTAPI

总体模块：   
![这里写图片描述][SouthEast]

### 运行程序 ###

只要php服务和python服务的开启在两个sidecar开启之前就好

JAVA程序的启动顺序为（从左到右）：

![DvXPVAp.png][]

我们访问`http://localhost:8761/`可以看到：

![zOdmLvY.png][]

两个非jvm语言的程序应用已经成功注册到eureka，并且是up的状态

我们关闭其中的一个python服务，可以看到：

![iGPSWqQ.png][]

php和python服务已经如同springboot程序一样，关闭即down，可以在注册中心看到它的运行状态了！

## 总结 ##

SideCar的设计很优雅，它完全不会去入侵其他应用的代码。就像一个代理一样，它始终观察着应用的运行（它的健康状态），本质上注册到eureka的是sidecar，但是它所显示的状态却是它所监测的应用。只要php、python..等为其提供一个health监测的接口即可！

代码已上传至： [https://github.com/KeoZmy/SpringCloudDemo.git][https_github.com_KeoZmy_SpringCloudDemo.git]

[https_github.com_KeoZmy_SpringCloudDemo.git]: https://github.com/KeoZmy/SpringCloudDemo.git
[ilU73lu.png]: http://i.imgur.com/ilU73lu.png
[WAMP_PHP Web]: http://jingyan.baidu.com/article/cd4c2979f4797e756e6e6086.html
[q7K3c0r.png]: http://i.imgur.com/q7K3c0r.png
[wamp_80]: http://jingyan.baidu.com/article/e3c78d644100e83c4c85f5d7.html
[h3H7XIB.png]: http://i.imgur.com/h3H7XIB.png
[tWIMLjS.png]: http://i.imgur.com/tWIMLjS.png
[Hblz6iN.png]: http://i.imgur.com/Hblz6iN.png
[ovJJGFH.png]: http://i.imgur.com/ovJJGFH.png
[Yjjg950.png]: http://i.imgur.com/Yjjg950.png
[SouthEast]: /images/20220523/79b7e80cc67747adaa6b4cc56f22adc7.png
[DvXPVAp.png]: http://i.imgur.com/DvXPVAp.png
[zOdmLvY.png]: http://i.imgur.com/zOdmLvY.png
[iGPSWqQ.png]: http://i.imgur.com/iGPSWqQ.png