SpringBoot使用protobuf格式的接口方式

SpringBoot使用protobuf格式的接口 建立SpringBoot项目,pom.xml内容如下:

4.0.0org.springframework.bootspring-boot-starter-parent2.2.2.RELEASE com.example.protobufdemo0.0.1-SNAPSHOTdemoDemo project for Spring Boot1.8org.springframework.bootspring-boot-starterorg.springframework.bootspring-boot-starter-testtestorg.junit.vintagejunit-vintage-enginecom.google.protobufprotobuf-java3.11.0com.google.protobufprotobuf-java-util3.11.0com.googlecode.protobuf-java-formatprotobuf-java-format1.2org.apache.httpcomponentshttpclient4.5.2org.apache.httpcomponentshttpcore4.4org.springframework.bootspring-boot-starterorg.springframework.bootspring-boot-starter-weborg.apache.commonscommons-lang33.0commons-collectionscommons-collections3.0【SpringBoot使用protobuf格式的接口方式】org.springframework.bootspring-boot-maven-plugin

编写.proto文件,内容如下:
user_login.proto:
syntax = "proto3"; option java_package = "com.boomsecret.protobuf"; option java_outer_classname = "MessageUserLogin"; message MessageUserLoginRequest {string username = 1; string password = 2; }message MessageUserLoginResponse {string access_token = 1; string username = 2; }

生成java代码:
protoc.exe --java_out=./ user_login.proto

将生成的代码移动到你的项目中合适位置:
SpringBoot使用protobuf格式的接口方式
文章图片

编写protobuf格式的Controller接口:
package com.example.protobuf.demo.controller; import com.boomsecret.protobuf.MessageUserLogin; import org.apache.http.HttpResponse; import org.apache.http.client.methods.HttpPost; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; import util.HttpUtils; import java.net.URI; import java.util.UUID; @Controllerpublic class TestController {@RequestMapping(value = "https://www.it610.com/demo/test", produces = "application/x-protobuf")@ResponseBodypublic MessageUserLogin.MessageUserLoginResponse getPersonProto(@RequestBody MessageUserLogin.MessageUserLoginRequest request) {MessageUserLogin.MessageUserLoginResponse.Builder builder = MessageUserLogin.MessageUserLoginResponse.newBuilder(); builder.setAccessToken(UUID.randomUUID().toString()+"_res"); builder.setUsername(request.getUsername()+"_res"); return builder.build(); }}

编写测试类,通过HttpClient工具调用接口:
package com.example.protobuf.demo; import com.boomsecret.protobuf.MessageUserLogin; import org.apache.http.HttpResponse; import org.apache.http.client.methods.HttpPost; import org.junit.jupiter.api.Test; import org.springframework.boot.test.context.SpringBootTest; import util.HttpUtils; import java.net.URI; @SpringBootTestclass DemoApplicationTests {@Testvoid contextLoads() {}@Testpublic void test() {try {URI uri = new URI("http", null, "127.0.0.1", 8080, "/demo/test", "", null); HttpPost request = new HttpPost(uri); MessageUserLogin.MessageUserLoginRequest.Builder builder = MessageUserLogin.MessageUserLoginRequest.newBuilder(); builder.setUsername("tom"); builder.setPassword("123456"); HttpResponse response = HttpUtils.doPost(request, builder.build()); MessageUserLogin.MessageUserLoginResponse messageUserLoginResponse = MessageUserLogin.MessageUserLoginResponse.parseFrom(response.getEntity().getContent()); System.err.println(messageUserLoginResponse.getAccessToken()); } catch (Exception e) {}}}

HttpUtils内容如下:
package util; import com.google.protobuf.GeneratedMessageV3; import com.googlecode.protobuf.format.JsonFormat; import org.apache.http.Header; import org.apache.http.HttpResponse; import org.apache.http.client.HttpClient; import org.apache.http.client.methods.HttpPost; import org.apache.http.entity.InputStreamEntity; import org.apache.http.impl.client.HttpClients; import java.io.ByteArrayInputStream; import java.io.IOException; /** * @author wangjinliang on 2018/10/18. */public class HttpUtils {public static HttpResponse doPost(HttpPost post, GeneratedMessageV3 message) throws IOException {HttpClient httpclient = HttpClients.createDefault(); String requestUrl = post.getURI().toString(); ByteArrayInputStream inputStream = new ByteArrayInputStream(message.toByteArray()); InputStreamEntity inputStreamEntity = new InputStreamEntity(inputStream); post.setEntity(inputStreamEntity); post.addHeader("Content-Type", "application/x-protobuf"); for (Header header : post.getAllHeaders()) {System.out.println(header.getName() + ":" + header.getValue()); }StringBuilder sb = new StringBuilder(); sb.append("curl -XPOST "); for (Header header : post.getAllHeaders()) {sb.append(" -H \"").append(header.getName()).append(":").append(header.getValue()).append("\""); }String jsonBody = JsonFormat.printToString(message); jsonBody = jsonBody.replace("\"", "\\\""); sb.append(" -d \"").append(jsonBody).append("\""); sb.append(" ").append(requestUrl); System.out.println(sb.toString()); return httpclient.execute(post); }}

以debug方式运行SpringBoot项目,并在controller加断点,然后运行测试代码:
SpringBoot使用protobuf格式的接口方式
文章图片

可以看到请求过来的数据是正确的,放行后可以看到响应数据也是正确的:
SpringBoot使用protobuf格式的接口方式
文章图片

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

    推荐阅读