基于gradle构建grpc-springboot

使用工具

idea + gradle

项目构建

创建空的父项目

创建一

注意此处使用gradle进行项目构建, 选择war,选择gradle,此处我们创建多模块项目,所以父项目并不需要src等目录,因为是笔者刚开始使用gradle,所以几乎每一步都是小心翼翼
创建二

创建三

此时完成了一个空项目,里面具有两个文件, settings.gradle和build.gradle

配置子项目的仓库地址, 在build.gradle中添加如下代码

subprojects {
    repositories {
        maven {
            url "https://maven.aliyun.com/repository/central"
        }
    }

}

创建lib子项目

上一篇文章我基于gradle构建了一个java项目并且根据proto生成了java文件,此处需要引用上篇中生成的文件
新建grpc-lib子项目

image.png

image.png

image.png

同理创建grpc-server和grpc-client,都是springboot-web项目,项目建成以后的目录如下图:

image.png

项目结构搭建完成,接下来完成基于springboot的grpc实现

1:springboot-grpc-demo/settings.gradle中配置,完成整合,表示这三个Module是属于同一个项目

rootProject.name = 'sprignboot-grpc-demo'
include 'grpc-lib',"grpc-server","grpc-client"

2:springboot-grpc-demo/build.gradle中为子项目做一些配置,此处指定maven仓库,也可以选择不指定

group 'com.example'
version '1.0-SNAPSHOT'

subprojects {
    repositories {
        mavenLocal()
        maven {
            url "https://maven.aliyun.com/repository/central"
        }
        mavenCentral()
    }
}

3:grpc-lib中引入所需依赖

plugins {
    id 'java'
}

group 'com.example.springboot-grpc-demo'
version '1.0-SNAPSHOT'
archivesBaseName="grpc-lib"
sourceCompatibility = 1.8

// 引入依赖
dependencies {
    compile "io.grpc:grpc-netty:1.10.0"
    compile "io.grpc:grpc-protobuf:1.10.0"
    compile "io.grpc:grpc-stub:1.10.0"
}

4:配置grpc-server的项目依赖等(grpc-server/build.gradle)

  buildscript {
    ext {
        springBootVersion = '2.0.5.RELEASE'
    }
    repositories {
        mavenLocal()
        maven{
            url "https://maven.aliyun.com/repository/central"
        }
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'java'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'
apply plugin: 'war'

group 'com.example.springboot-grpc-demo'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
archivesBaseName="grpc-server"
repositories {
    mavenLocal()
    maven{
        url "https://maven.aliyun.com/repository/central"
    }
    mavenCentral()
}

configurations {
    providedRuntime
}

dependencies {
    //引入grpc-lib模块
    compile project(":grpc-lib")
    //引入grpc-server所需依赖,springboot集成的
    compile 'net.devh:grpc-server-spring-boot-starter:1.4.0.RELEASE'
    compile('org.springframework.boot:spring-boot-starter-web')
    providedRuntime('org.springframework.boot:spring-boot-starter-tomcat')
}

5:grpc-client配置(grpc-client/build.gradle)

buildscript {
    ext {
        springBootVersion = '2.0.5.RELEASE'
    }
    repositories {
        mavenLocal()
        maven{
            url "https://maven.aliyun.com/repository/central"
        }
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'java'
apply plugin: "idea"
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'
apply plugin: 'war'

group 'com.example.springboot-grpc-demo'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
archivesBaseName="grpc-client"

configurations {
    providedRuntime
}

repositories {
    mavenLocal()
    maven{
        url "https://maven.aliyun.com/repository/central"
    }
    mavenCentral()
}

dependencies {
    // 引入grpc-lib
    compile project(":grpc-lib")
    // 此处和上面server配置中不一样哦
    compile 'net.devh:grpc-client-spring-boot-starter:1.4.0.RELEASE'
    compile('org.springframework.boot:spring-boot-starter-web')
    providedRuntime('org.springframework.boot:spring-boot-starter-tomcat')
}

项目搭建及配置完成,终于要开始写代码了,吼吼

grpc实现

1:按照上篇文章中的内容,命令行输入 gradle compileJava完成对hello.proto的编译


grpc-lib

2:编写grpc-server,新建service/HelloService.java (interface) 、service/impl/HelloServiceImpl.java
HelloServiceImpl代码

@GrpcService(HelloServiceGrpc.class)
public class HelloServiceImpl extends HelloServiceGrpc.HelloServiceImplBase implements HelloService {

    private static final Logger LOG = LoggerFactory.getLogger(HelloServiceImpl.class);

    @Override
    public void sayHello(HelloRequest request, StreamObserver<HelloResponse> responseObserver) {
        String name = request.getName();
        LOG.info("received client name is " + name);
        HelloResponse response = HelloResponse.newBuilder().setCode("0000").setMessage("hello "+ name).build();
        responseObserver.onNext(response);
        responseObserver.onCompleted();
    }
}

3:编写grpc-client,新建service/HelloService.java (interface) 、service/impl/HelloServiceImpl.java 、controller\HelloController
因为client也需要提供接口给前端访问,所以就需要controller
(1)HelloService.java代码

public interface HelloService {
    //此处没有深入做封装,简单演示
    Map getGreeting (String name);
}

(2)HelloServiceImpl代码

//方便大家观察,把导入的包也放上来
import com.example.grpcclient.service.HelloService;
import com.geek.grpc.lib.hello.HelloRequest;
import com.geek.grpc.lib.hello.HelloResponse;
import com.geek.grpc.lib.hello.HelloServiceGrpc;
import io.grpc.Channel;

@Service
public class HelloServiceImpl extends HelloServiceGrpc.HelloServiceImplBase implements HelloService {

    @GrpcClient("grpc_local_server")
    private Channel channel;

    @Override
    public Map getGreeting(String name) {
        HelloServiceGrpc.HelloServiceBlockingStub blockingStub = HelloServiceGrpc.newBlockingStub(channel);
        HelloResponse response = blockingStub.sayHello(HelloRequest.newBuilder().setName(name).build());
        Map map = new HashMap();
        map.put("code", response.getCode());
        map.put("msg", response.getMessage());
        return map;
    }
}

(3)HelloController代码

@RestController
public class HelloController {

    @Autowired
    private HelloService helloService;

    @GetMapping("/hello")
    public Map sayHello(String name){
        return helloService.sayHello(name);
    }
}

完成以上步骤,代码编写完成,本文不做代码详细释义,具体参考官网API文档

项目启动和准备调用配置

grpc-server/src/main/resources/application.properties(熟悉springboot的猿和媛就可以用自己的配置了)

server.port=8081
spring.application.name=grpc-local-server
grpc.server.port=9898

grpc-client/src/main/resources/application.properties

server.port=8082
spring.application.name=grpc-local-client
grpc.client.grpc_local_server.host=127.0.0.1
grpc.client.grpc_local_server.port=9898
grpc.client.grpc_local_server.enableKeepAlive=true
grpc.client.grpc_local_server.keepAliveWithoutCalls=true

启动调用

启动grpc-client和grpc-server,然后浏览器中访问http://localhost:8082/hello?name=World

访问结果

同时,我们查看grpc-server控制台
console结果

码云地址:https://gitee.com/devilscode/grpc-boot-simple

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,778评论 6 342
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,827评论 25 707
  • 最近在研究品牌广告的内容,以及相关媒体投放,因此对相关信息进行了总结。 北京: 通城地铁广告(原申通德高JSDC)...
    LucyChen阅读 1,340评论 0 6
  • ​ 目前在负责公司的一个前端项目,现有的版本是基于Ext.js框架进行搭建,但Ext.js显得过重,而且构建后...
    智明书阅读 381评论 0 0