SpringBoot集成SOFA-RPC+Zookeeper

1. 快速开始

1.1 环境准备

JDK7+
需要采用 Apache Maven 3.2.5 或者以上的版本来编译

创建工程

直接在 https://start.spring.io/ 构建Spring Boot工程。构建时可以添加一些常用依赖，例如：添加 Web 的依赖，以便最后在浏览器中查看效果。

1.png

1.2 pom文件引入依赖

替换前：
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.5.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
替换后：
<parent>
    <groupId>com.alipay.sofa</groupId>
    <artifactId>sofaboot-dependencies</artifactId>
    <version>2.3.1</version>
</parent>

dependencies下添加一下依赖：

 <!--SOFABoot 健康检查 -->
<dependency>
        <groupId>com.alipay.sofa</groupId>
        <artifactId>healthcheck-sofa-boot-starter</artifactId>
</dependency>
<!-- SOFA-RPC 环境 -->
<dependency>
    <groupId>com.alipay.sofa</groupId>
    <artifactId>rpc-sofa-boot-starter</artifactId>
</dependency>
<!-- Zookeeper 作为服务注册列表 -->
<dependency>
    <groupId>com.101tec</groupId>
    <artifactId>zkclient</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.apache.zookeeper</groupId>
            <artifactId>zookeeper</artifactId>
        </exclusion>
    </exclusions>
    <version>0.10</version>
</dependency>

完整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>
    <parent>
        <groupId>com.alipay.sofa</groupId>
        <artifactId>sofaboot-dependencies</artifactId>
        <version>2.3.1</version>
    </parent>
    <groupId>com.sofa.demo</groupId>
    <artifactId>sofa-client-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>sofa-client-demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--SOFABoot 健康检查 -->
        <dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>healthcheck-sofa-boot-starter</artifactId>
        </dependency>
        <!-- SOFA-RPC 环境 -->
        <dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>rpc-sofa-boot-starter</artifactId>
        </dependency>
        <!-- Zookeeper 作为服务注册列表 -->
        <dependency>
            <groupId>com.101tec</groupId>
            <artifactId>zkclient</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-api</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-log4j12</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.zookeeper</groupId>
                    <artifactId>zookeeper</artifactId>
                </exclusion>
            </exclusions>
            <version>0.10</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
        </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-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

1.4 application.properties配置

##当前应用端口
server.port=8081
##当前应用名称（不能删除，作为eureka服务时，名称不能带下划线“_”,可为“-”，否则注册中心访问不到指定服务）
spring.application.name=SOFA-BIP-Client
## logging path
logging.path=./logs
## zookeeper address list
com.alipay.sofa.rpc.registry.address=zookeeper://127.0.0.1:2181

com.alipay.sofa.rpc.registry.address属性指：配置zookeeper地址。

1.5 编写sofa服务接口和实现类

sofa提供者工程结构图：

2.png

HelloSyncService.java

package com.uisftech.bip.service;
public interface HelloSyncService {
    String saySync(String string);
}

HelloSyncServiceImpl.java

package com.sofa.demo.service.impl;

import com.sofa.demo.service.HelloSyncService;

public class HelloSyncServiceImpl implements HelloSyncService {

    @Override
    public String saySync(String sync) {
        // TODO Auto-generated method stub
        return sync;
    }

}

1.6 编写sofa服务提供方配置文件

bip-sofa-service.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:sofa="http://sofastack.io/schema/sofaboot"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            http://sofastack.io/schema/sofaboot http://sofastack.io/schema/sofaboot.xsd"
    default-autowire="byName">
    <bean id="helloSyncServiceImpl"
        class="com.sofa.demo.service.impl.HelloSyncServiceImpl" />

    <!-- 以多种通信协议发布服务 -->
    <sofa:service ref="helloSyncServiceImpl"
        interface="com.sofa.demo.service.HelloSyncService">
        <sofa:binding.bolt />
        <sofa:binding.rest />
        <sofa:binding.dubbo />
    </sofa:service>
</beans>

通过sofa:service元素将该服务发布，其中ref属性表示发布的服务实例，interface 属性表示该服务的接口。
bolt: 服务通过 bolt 协协议通道发布，底层基于 Netty 实现。
rest: 服务通过 http 协议发布。
dubbo: 服务基于 dubbo 的协议通道发布。

1.7 编写服务提供方启动程序

package com.sofa.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.ImportResource;

@SpringBootApplication
@ImportResource({ "classpath:bip-sofa-service.xml" })
public class SimpleServerApplication {

    public static void main(String[] args) {
        SpringApplication springApplication = new SpringApplication(SimpleServerApplication.class);
        ApplicationContext applicationContext = springApplication.run(args);
    }
}

以上是sofa服务提供者创建步骤，接下来新建sofa服务消费方工程。

创建消费方工程以及pom文件修改、application.properties文件配置直接参考服务提供者工程1.2-1.4步骤，内容一样的。需要注意的是两个工程的application.properties文件中的server.port端口不能一样。

sofa消费方工程结构图：

3.png

1.1 新建sofa服务接口

从工程图中可以看出，我们需要消费谁提供的接口，就必须在自己工程中按提供者接口原路径新建一个一模一样的接口类。

一般都是提供者会把接口定义类会给我们，我们新建好包路径直接把提供者接口类放进去就行，包路径必须一致。

1.2 编写sofa服务消费方配置文件

bip-sofa-client.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:sofa="http://sofastack.io/schema/sofaboot"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            http://sofastack.io/schema/sofaboot http://sofastack.io/schema/sofaboot.xsd"
    default-autowire="byName">

    <!-- bolt引用 -->
    <sofa:reference id="boltHelloSyncServiceReference"
        interface="com.uisftech.bip.service.HelloSyncService">
        <sofa:binding.bolt />
    </sofa:reference>

    <!-- rest引用 -->
    <sofa:reference id="restHelloSyncServiceReference"
        interface="com.uisftech.bip.service.HelloSyncService">
        <sofa:binding.rest />
    </sofa:reference>

    <!-- dubbo引用 -->
    <sofa:reference id="dubboHelloSyncServiceReference"
        interface="com.uisftech.bip.service.HelloSyncService">
        <sofa:binding.dubbo />
    </sofa:reference>
</beans>

1.3 编写服务消费方启动程序

package com.uisftech.bip;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.ImportResource;

import com.uisftech.bip.service.HelloSyncService;

@ImportResource({ "classpath:bip-sofa-client.xml" })
@SpringBootApplication
public class SimpleClientApplication {

    public static void main(String[] args) {

        SpringApplication springApplication = new SpringApplication(SimpleClientApplication.class);
        ApplicationContext applicationContext = springApplication.run(args);

        HelloSyncService boltHelloSyncService = (HelloSyncService) applicationContext
                .getBean("boltHelloSyncServiceReference");
        HelloSyncService restHelloSyncService = (HelloSyncService) applicationContext
                .getBean("restHelloSyncServiceReference");
        HelloSyncService dubboHelloSyncService = (HelloSyncService) applicationContext
                .getBean("dubboHelloSyncServiceReference");

        System.out.println("Bolt result:" + boltHelloSyncService.saySync("bolt"));
        System.out.println("Rest result:" + restHelloSyncService.saySync("rest"));
        System.out.println("Dubbo result:" + dubboHelloSyncService.saySync("dubbo"));
    }
}

注意：因SOFA注册机制，测试时需要两台机器，一台启动sofa服务提供者，一台启动sofa服务消费者。
分别启动服务端和客户端，客户端控制台输出日志如下：
启动之前一定要记得启动zookeeper注册中心

4.png

注意：

maven聚合工程，父级的pom需要引入sofaboot-dependencies依赖：

<!--sofa开源集成zookeeper -->
<parent>
    <groupId>com.alipay.sofa</groupId>
    <artifactId>sofaboot-dependencies</artifactId>
    <version>2.3.1</version>
</parent>

maven聚合工程，子工程pom依赖则不要引入sofaboot-dependencies，其它sofa依赖引入和上面提到的一样，具体引入依赖参考如下代码：

<!--***sofa开源集成zookeeper*** -->
        <!--SOFABoot 健康检查 -->
        <dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>healthcheck-sofa-boot-starter</artifactId>
        </dependency>
        <!-- SOFA-RPC 环境 -->
        <dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>rpc-sofa-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>${guava-version}</version>
        </dependency>
        <!-- Zookeeper 作为服务注册列表 -->
        <dependency>
            <groupId>com.101tec</groupId>
            <artifactId>zkclient</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-api</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-log4j12</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.zookeeper</groupId>
                    <artifactId>zookeeper</artifactId>
                </exclusion>
            </exclusions>
            <version>0.10</version>
        </dependency>
<!--***sofa开源集成zookeeper-end*** -->

引用段落
学习过程中参考了零壹技术栈文章，写的很好，大家可以看看。

最后编辑于：2019.05.24 15:19:27

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