EDAS入门-springcloud+HSF开发实战

淩亂°似流年 2022-05-13 13:16 348阅读 0赞

该系列博文旨在整理阿里云帮助文档中有关EDAS开发相关知识，自己在写学习了解时，个人在理解阿里帮助文档之后，整理代码使其更适合企业级应用，顺便做个备忘录。

## 前言 ##

目前 EDAS 已经完全支持 Spring Cloud 应用了，您可以将 Spring Cloud 应用直接部署到 EDAS 中。

*  Spring Boot 提出的概念是 Build Anything，解决繁琐的 xml 配置的问题。
 *  Spring Cloud 提出的概念是 Coordinate Anything，通过提供大量的、方便组件接入的 spring-cloud-starter 的支持，简化了分布式微服务的开发。

EDAS 也实现了自己的 Spring Cloud Starter HSF，您同样可以通过 Spring Cloud 来开发 HSF 应用。 本文档将介绍如何使用 Spring Cloud 来开发 HSF 应用。

该文档参考阿里帮助文档：[https://help.aliyun.com/document\_detail/63867.html?spm=a2c4g.11186623.6.667.1e40cab5VVvbG8][https_help.aliyun.com_document_detail_63867.html_spm_a2c4g.11186623.6.667.1e40cab5VVvbG8]

源码地址：[https://github.com/feifuzeng/sc-edas-demo][https_github.com_feifuzeng_sc-edas-demo]

## 创建POM工程 ##

1.  创建一个POM工程，取名sc-edas-demo,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>
        
            <groupId>com.feifz</groupId>
            <artifactId>sc-edas</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <packaging>pom</packaging>
        
            <name>sc-edas</name>
            <description>EDAS 入门 springcloud+HSF</description>
        
            <modules>
                <module>sc-edas-api</module>
                <module>sc-edas-provider</module>
                <module>sc-edas-consumer</module>
            </modules>
            <parent>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-parent</artifactId>
                <version>1.5.8.RELEASE</version>
                <relativePath/> 
            </parent>
        
            <properties>
                <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
                <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
                <java.version>1.8</java.version>
            </properties>
        
        
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-maven-plugin</artifactId>
                    </plugin>
                </plugins>
            </build>
        
        </project>

## 创建服务提供者及API工程 ##

1.  创建一个 普通maven工程，命名为 sc-edas-api，在该工程内定义提供者暴露的所有HSF服务，单独发布成jar供调用方使用
2.  创建创建一个 Spring Cloud 工程，命名为 sc-edas-provider，端口设置为18081
3.   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>
        
            <groupId>com.feifz</groupId>
            <artifactId>sc-edas-provider</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <packaging>jar</packaging>
        
            <name>sc-edas-provider</name>
            <description>提供者</description>
        
            <parent>
                <groupId>com.feifz</groupId>
                <artifactId>sc-edas</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </parent>
        
            <dependencies>
                
                <dependency>
                    <groupId>com.feifz</groupId>
                    <artifactId>sc-edas-api</artifactId>
                    <version>0.0.1-SNAPSHOT</version>
                </dependency>
        
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-hsf</artifactId>
                    <version>1.3</version>
                </dependency>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-pandora</artifactId>
                    <version>1.3</version>
                </dependency>
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-web</artifactId>
                </dependency>
        
            </dependencies>
            <dependencyManagement>
                <dependencies>
                    <dependency>
                        <groupId>org.springframework.cloud</groupId>
                        <artifactId>spring-cloud-dependencies</artifactId>
                        <version>Dalston.SR4</version>
                        <type>pom</type>
                        <scope>import</scope>
                    </dependency>
                </dependencies>
            </dependencyManagement>
        
        
        </project>
    
    虽然 HSF 服务框架并不依赖于 Web 环境，但是 EDAS 管理应用的生命周期过程中需要使用到 Web 相关的特性，所以需要添加spring-boot-starter-web 的依赖。 如果您的工程不想将 parent 设置为 spring-boot-starter-parent，也可以通过如下方式添加 dependencyManagement ，设置 scope=import ，来达到依赖版本管理的效果。
    
        <dependencyManagement>
             <dependencies>
                 <dependency>          
                     <groupId>org.springframework.boot</groupId>
                     <artifactId>spring-boot-dependencies</artifactId>
                     <version>1.5.8.RELEASE</version>
                     <type>pom</type>
                     <scope>import</scope>
                 </dependency>
             </dependencies>
         </dependencyManagement>
    
    注意，其中提供者工程里引入了api工程jar包，目的为方便消费者消费时与提供者提供的包路径信息相同。对于api工程中定义的接口具体实现均在提供者工程里进行实现并添加注解进行暴露服务，具体可见提供者工程代码。
4.  在api工程中定义接口
    
        package com.feifz.scedasapi.api;
        
        /**
         * @author feifz
         * @version 1.0.0
         * @Description 示例接口
         * @Date 2018/10/24 15:08
         */
        public interface HelloService {
        
            public String hello(String str);
        }
    
     
5.  在provider工程编写api接口实现
    
        package com.feifz.scedasprovider.service;
        
        import com.alibaba.boot.hsf.annotation.HSFProvider;
        import com.feifz.scedasapi.api.HelloService;
        
        /**
         * @author feifz
         * @version 1.0.0
         * @Description TOOD
         * @Date 2018/10/24 15:09
         */
        @HSFProvider(serviceGroup = "sc-edas-provider",serviceInterface = HelloService.class ,serviceVersion = "1.0.0")
        public class HelloServiceImpl implements HelloService {
        
        
            @Override
            public String hello(String str) {
                return "sc-edas-provider-提供者返回->"+str;
            }
        }
    
     
6.  在启动类main方法添加PandoraBootstrap启动
    
        package com.feifz.scedasprovider;
        
        import com.taobao.pandora.boot.PandoraBootstrap;
        
        import org.springframework.boot.SpringApplication;
        import org.springframework.boot.autoconfigure.SpringBootApplication;
        
        /**
         * 提供者启动类
         */
        @SpringBootApplication
        public class ScEdasProviderApplication {
        
            public static void main(String[] args) {
                // 启动 Pandora Boot 用于加载 Pandora 容器
                PandoraBootstrap.run(args);
                SpringApplication.run(ScEdasProviderApplication.class, args);
                // 标记服务启动完成,并设置线程 wait。防止业务代码运行完毕退出后，导致容器退出。
                PandoraBootstrap.markStartupAndWait();
            }
        }

## 创建消费者工程 ##

1.  创建消费者springCloud,取名sc-edas-consumer，端口设置为18082
2.  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>
        
            <groupId>com.feifz</groupId>
            <artifactId>sc-edas-consumer</artifactId>
            <version>0.0.1-SNAPSHOT</version>
            <packaging>jar</packaging>
        
            <name>sc-edas-consumer</name>
            <description>消费者</description>
        
            <parent>
                <groupId>com.feifz</groupId>
                <artifactId>sc-edas</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </parent>
            <dependencies>
                
                <dependency>
                    <groupId>com.feifz</groupId>
                    <artifactId>sc-edas-api</artifactId>
                    <version>0.0.1-SNAPSHOT</version>
                </dependency>
        
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-hsf</artifactId>
                    <version>1.3</version>
                </dependency>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-pandora</artifactId>
                    <version>1.3</version>
                </dependency>
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-web</artifactId>
                </dependency>
            </dependencies>
            <dependencyManagement>
                <dependencies>
                    <dependency>
                        <groupId>org.springframework.cloud</groupId>
                        <artifactId>spring-cloud-dependencies</artifactId>
                        <version>Dalston.SR4</version>
                        <type>pom</type>
                        <scope>import</scope>
                    </dependency>
                </dependencies>
            </dependencyManagement>
        </project>
    
     
3.  编写消费者配置类，通过注解的方式将服务消费者的实例注入到 Spring 的 Context 中。在 Config 类里配置一次 @HSFConsumer ，然后在多处通过 @Autowired 注入使用。通常一个 HSF Consumer 需要在多个地方使用，但并不需要在每次使用的地方都用 @HSFConsumer 来标记。只需要写一个统一的 Config 类，然后在其它需要使用的地方，直接通过 @Autowired 注入即可。
    
        package com.feifz.scedasconsumer;
        
        import com.alibaba.boot.hsf.annotation.HSFConsumer;
        import com.feifz.scedasapi.api.HelloService;
        
        import org.springframework.context.annotation.Configuration;
        
        /**
         * @author feifz
         * @version 1.0.0
         * @Description 消费者 配置类
         * @Date 2018/10/24 15:20
         */
        @Configuration
        public class HsfConfig {
        
            @HSFConsumer(serviceGroup = "sc-edas-provider",clientTimeout = 3000,serviceVersion = "1.0.0")
            private HelloService helloService;
        }
    
     
4.  编写control层demo代码
    
        package com.feifz.scedasconsumer.control;
        
        
        import com.feifz.scedasapi.api.HelloService;
        
        import org.springframework.beans.factory.annotation.Autowired;
        import org.springframework.web.bind.annotation.PathVariable;
        import org.springframework.web.bind.annotation.RequestMapping;
        import org.springframework.web.bind.annotation.RequestMethod;
        import org.springframework.web.bind.annotation.RestController;
        
        /**
         * @author feifz
         * @version 1.0.0
         * @Description 消费者 示例controller
         * @Date 2018/10/24 15:29
         */
        @RestController
        public class HelloController {
        
            @Autowired
            private HelloService helloService;
        
            @RequestMapping(value = "/hello/{str}",method = RequestMethod.GET)
            public String hello(@PathVariable String str){
                return helloService.hello(str);
            }
        }
    
    **注：**在IDEA中编写该control时，IDEA可能会提示Could not autowire. No beans of 'HelloService' type found，可忽略，正常编译运行即可。
5.  在启动类main方法添加PandoraBootstrap启动
    
        package com.feifz.scedasconsumer;
        
        import com.taobao.pandora.boot.PandoraBootstrap;
        
        import org.springframework.boot.SpringApplication;
        import org.springframework.boot.autoconfigure.SpringBootApplication;
        
        /**
         * 消费者 启动类
         */
        @SpringBootApplication
        public class ScEdasConsumerApplication {
        
            public static void main(String[] args) {
                // 启动 Pandora Boot 用于加载 Pandora 容器
                PandoraBootstrap.run(args);
                SpringApplication.run(ScEdasConsumerApplication.class, args);
                // 标记服务启动完成,并设置线程 wait。防止业务代码运行完毕退出后，导致容器退出。
                PandoraBootstrap.markStartupAndWait();
            }
        }

## 启动运行 ##

1.  依次启动sc-edas-provider工程、sc-edas-consumer工程，访问 [http://127.0.0.1:18082/hello/world][http_127.0.0.1_18082_hello_world]
2.  服务返回：sc-edas-provider-提供者返回->world

### 欢迎关注微信公众号：码仔zonE ###

![2020081910375831.png][]

[https_help.aliyun.com_document_detail_63867.html_spm_a2c4g.11186623.6.667.1e40cab5VVvbG8]: https://help.aliyun.com/document_detail/63867.html?spm=a2c4g.11186623.6.667.1e40cab5VVvbG8
[https_github.com_feifuzeng_sc-edas-demo]: https://github.com/feifuzeng/sc-edas-demo
[http_127.0.0.1_18082_hello_world]: http://127.0.0.1:18082/hello/world
[2020081910375831.png]: /images/20220504/88325f8799e844c1a1b0b3d385c1fb22.png