Spring Cloud Contract实践

约定不等于承诺〃 2021-10-19 07:16 265阅读 0赞

**1.Spring Cloud Contract简介**  
Spring Cloud Contract是一个总体项目，其中包含帮助用户成功实施消费者驱动合同方法的解决方案。目前，Spring Cloud Contract包含Spring Cloud Contract Verifier项目。  
**2.什么是契约测试**  
契约测试 ，又称之为 消费者驱动的契约测试(Consumer-Driven Contracts，简称CDC)，根据 消费者驱动契约 ，我们可以将服务分为消费者端和生产者端，而消费者驱动的契约测试的核心思想在于是从消费者业务实现的角度出发，由消费者自己会定义需要的数据格式以及交互细节，并驱动生成一份契约文件。然后生产者根据契约文件来实现自己的逻辑，并在持续集成环境中持续验证。  
**3.现有微服务架构下的测试痛点**  
目前我们服务联调测试是这样的：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70]  
这样的情况存在主要问题如下：  
1.联调依赖被调用服务逻辑。  
2.被联调服务未开发完成，测试无法进行下去。  
3.一次测试需要部署所有服务。  
4.不能及时给予测试反馈，运行时间长。  
**4.微服务特点**  
在了解契约测试前我们先看下微服务特点：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 1]  
**5.契约测试核心原则**  
1.以消费者提出接口契约，交由服务提供方实现，并以测试用例对契约进行产生约束，所以服务提供方在满足测试用例的情况下可以自行更改接口或架构实现而不影响消费者。  
2.是一种针对外部服务的接口进行的测试，它能够验证服务是否满足消费方期待的契约。 它的本质是从利益相关者的目标和动机出发，最大限度地满足需求方的业务价值实现。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 2]

> 对于官方及大部分博文以消费者提出接口契约的方式，本图是以提供者编写契约及上传契约。个人认为这样更合理。

**6.示例代码**  
**1). 提供端相关代码**  
**1.导入Contract测试相关包：**

<dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-contract-verifier</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-contract-stub-runner</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-contract-maven-plugin</artifactId>
                    <version>2.0.2.RELEASE</version>
                    <extensions>true</extensions>
                </plugin>
            </plugins>
        </build>

**2.编写测试类**  
在项目的test文件夹下新建resources文件夹，建立我们的契约文件：shouldReturnAllCustomers.groovy  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 3]  
shouldReturnAllCustomers.groovy相关内容如下：

package contracts
    
    import org.springframework.http.HttpHeaders
    import org.springframework.http.MediaType
    
    org.springframework.cloud.contract.spec.Contract.make {
        description "return all customers"
    
        request {
            url "/api/customers"
            method GET()
        }
    
        response {
            status 200
            headers {
                header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_UTF8_VALUE)
            }
            body("hello world")
    
        }
    }

我们看到有三个部分：description、request、response。通过request定义了请求时的url和method，然后通过response约定返回时的headers和body信息。  
契约采用groovy的DSL描述，所以一目了然，就是通过项url：/api/customers，发送一个get请求，我们返回hello world。  
**3.发布契约**  
执行`clean deploy`生成我们的契约并上传到nexus库。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 4]  
**2).消费端编写测试类**  
**1.消费端引入相关jar**

<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-contract-stub-runner</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-contract-wiremock</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

application-stub.yml配置如下：

stubrunner:
      stubs-mode: REMOTE
      repositoryRoot: http://sit.shk.com.cn:8080/nexus-2.9.1-02/content/repositories/snapshots
      ids:
        - com.uaf:nlp-contract-provider:+:stubs:8090

**2.消费端编写测试类**

@RunWith(SpringRunner.class)
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)
    @AutoConfigureMockMvc
    @AutoConfigureJsonTesters
    @AutoConfigureStubRunner
    @ActiveProfiles("stub")
    public class ConsumerContractTest {
    
    	private MockMvc mockMvc;
    
    	@Autowired
    	private WebApplicationContext webApplicationContext;
    
    	@Autowired
    	private CustomerConsumerAction customerConsumerAction;
    
    	@Before
    	public void setUp() {
    		mockMvc = MockMvcBuilders.standaloneSetup(customerConsumerAction).build();
    	}
    
    	@Test
    	public void testGetCustomers1() throws Exception {
    		mockMvc.perform(MockMvcRequestBuilders.get("/cus")).andExpect(MockMvcResultMatchers.status().isOk())
    				.andDo(MockMvcResultHandlers.print());
    
    	}
    }

执行测试类，通过观察console输出我们看下如下信息，说明我们契约测试成功。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 5]

--------------------

欢迎关注公众号： **编码是个技术活**

![在这里插入图片描述][20210219162337578.jpg_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70]: /images/20211018/447a5b44b4134c778b8e5c20e80ea265.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 1]: /images/20211018/3ba0fca7ecb149c4b248444b3f19b8cf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 2]: /images/20211018/bfa1c8b541884d8baab2060326ff5198.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 3]: /images/20211018/d056ebf9a96947a89a497814596eba2c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 4]: /images/20211018/2f48cd1cd3894dd0ab833553db4a0bfe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmdjaGVuZ2FpaHVpbWluZw_size_16_color_FFFFFF_t_70 5]: /images/20211018/bc1e398cba5248979b0d99b4c1ddf1c4.png
[20210219162337578.jpg_pic_center]: /images/20211018/2980f911723849f097e2f1b1e9f86c39.png