Spring Boot文档阅读笔记-构建Restful风格的WebService客户端

淡淡的烟草味﹌ 2022-12-28 12:47 90阅读 0赞

对应的maven如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.4.1</version>
            <relativePath/> 
        </parent>
        <groupId>cn.it1995</groupId>
        <artifactId>demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>demo</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        <excludes>
                            <exclude>
                                <groupId>org.projectlombok</groupId>
                                <artifactId>lombok</artifactId>
                            </exclude>
                        </excludes>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    </project>

这里官方已经提供了一个WebService服务端的地址:

[https://gturnquist-quoters.cfapps.io/api/random][https_gturnquist-quoters.cfapps.io_api_random]

他会生成由quotation对象生成的JSON。

如下JSON

{
       type: "success",
       value: {
          id: 10,
          quote: "Really loving Spring Boot, makes stand alone Spring apps easy."
       }
    }

使用RestTemplate与WebService进行交互

创建Quote类用于接收WebService传来的数据，Quote代码如下：

package cn.it1995.demo;
    
    import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
    
    @JsonIgnoreProperties(ignoreUnknown = true)
    public class Quote {
    
        private String type;
        private Value value;
    
        public Quote(){
    
        }
    
        public String getType() {
            return type;
        }
    
        public void setType(String type) {
            this.type = type;
        }
    
        public Value getValue() {
            return value;
        }
    
        public void setValue(Value value) {
            this.value = value;
        }
    
        @Override
        public String toString() {
            return "Quote{" +
                    "type='" + type + '\'' +
                    ", value=" + value +
                    '}';
        }
    }

@JsonIgnoreProperties注解来源于Jackson库，作用是忽略属性的绑定，如果变量名和传输过来的json的名是一样的，就可以直接绑定，如果不一样，需要使用@JsonProperty进行明确的指定。

下面是关于JSON中value对应的java类代码：

package cn.it1995.demo;
    
    import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
    
    @JsonIgnoreProperties(ignoreUnknown = true)
    public class Value {
    
        private Long id;
        private String quote;
    
        public Value(){
    
        }
    
        public Long getId() {
            return id;
        }
    
        public void setId(Long id) {
            this.id = id;
        }
    
        public String getQuote() {
            return quote;
        }
    
        public void setQuote(String quote) {
            this.quote = quote;
        }
    
        @Override
        public String toString() {
            return "Value{" +
                    "id=" + id +
                    ", quote='" + quote + '\'' +
                    '}';
        }
    }

下面是发起请求相关的代码：

package cn.it1995.demo;
    
    import org.springframework.boot.CommandLineRunner;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.web.client.RestTemplateBuilder;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.client.RestTemplate;
    
    @SpringBootApplication
    public class DemoApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
    
        @Bean
        public RestTemplate restTemplate(RestTemplateBuilder builder){
    
            return builder.build();
        }
    
    
        @Bean
        public CommandLineRunner runner(RestTemplate restTemplate){
    
            byte[] b = new byte[]{1, 2};
            System.out.println(b);
    
            return args -> {
    
                Quote quote = restTemplate.getForObject("https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
                System.out.println(quote);
            };
        }
    }

RestTemplate使用JackSon的JSON库将传输过来的json转换为对象。编程里面的对象，不是你们的对象，这个要注意。

程序运行截图如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70][]

程序打包下载地址：

[https://github.com/fengfanchen/Java/tree/master/RestWebServiceClient][https_github.com_fengfanchen_Java_tree_master_RestWebServiceClient]

[https_gturnquist-quoters.cfapps.io_api_random]: https://gturnquist-quoters.cfapps.io/api/random
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxNzg0NDI3NjE_size_16_color_FFFFFF_t_70]: /images/20221120/23fce2c908a24501bc8b2d4a2943a407.png
[https_github.com_fengfanchen_Java_tree_master_RestWebServiceClient]: https://github.com/fengfanchen/Java/tree/master/RestWebServiceClient