对于eureka的入门使用
一、整体框架搭建
1、父工程即idea环境
idea配置环境:
字符编码
注解生效激活
java编译版本选8
maven配置
配置成自己的maven地址
配置RunDashboard:在.idea文件夹下找到workspace.xml文件在<component name="RunDashboard">标签下加入
<option name="configurationTypes"> <set> <option value="SpringBootApplicationConfigurationType"/> </set> </option> <option name="ruleStates"> <list> <RuleState> <option name="name" value="ConfigurationTypeDashboardGroupingRule"/> </RuleState> <RuleState> <option name="name" value="StatusDashboardGroupingRule"/> </RuleState> </list> </option>
父工程:
1、pom:(如果dependencyManagement中由爆红,则先将dependencyManagement标签去掉等不暴红再加上去)
<!-- 统一管理jar包版本 --> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <junit.version>4.12</junit.version> <log4j.version>1.2.17</log4j.version> <lombok.version>1.16.18</lombok.version> <mysql.version>5.1.47</mysql.version> <druid.version>1.1.16</druid.version> <mybatis.spring.boot.version>1.3.0</mybatis.spring.boot.version> </properties> <!-- 子模块继承之后,提供作用:锁定版本+子modlue不用写groupId和version --> <dependencyManagement> <!-- dependencyManagement: 通常会在一个组织或项目的最顶层的父pom中看到dependencyManagement元素。 dependencies: --> <dependencies> <!--spring boot 2.2.2--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>2.2.2.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> <!--spring cloud Hoxton.SR1--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Hoxton.SR1</version> <type>pom</type> <scope>import</scope> </dependency> <!--spring cloud alibaba 2.1.0.RELEASE--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-alibaba-dependencies</artifactId> <version>2.1.0.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>${mysql.version}</version> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid</artifactId> <version>${druid.version}</version> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>${mybatis.spring.boot.version}</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>${junit.version}</version> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>${log4j.version}</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>${lombok.version}</version> <optional>true</optional> </dependency> </dependencies> </dependencyManagement> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <fork>true</fork> <addResources>true</addResources> </configuration> </plugin> </plugins> </build>
这里搭建两个服务:订单服务+支付服务,然后将不同的组件逐个加入使用
2、eureka服务(新建服务cloud-Eureka-server7001)
pom:
<dependencies> <!--eureka-server:服务端依赖--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId> </dependency> <!--boot web acctuator--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency> </dependencies>
yml:
server: port: 7001 eureka: instance: hostname: 127.0.0.1 #eureka服务端实例名称 单机版 #hostname: eureka7001.com #eureka服务端实例名称 client: #表示不向注册中心注册自己 register-with-eureka: false #false表示自己就是注册中心,我的职责就是维护服务实例,并不区检索服务 fetch-registry: false service-url: #设置与Eureka server交互的地址查询服务和注册服务都需要依赖这个地址 defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/ #单机版
启动类:
@SpringBootApplication @EnableEurekaServer public class EurekaMain7001 { public static void main(String[] args) { SpringApplication.run(EurekaMain7001.class,args); } }
开启启动类并访问http://localhost:7001/
3、将两个微服务都要用到的一些实体类等公告信息放到commons模块(新建模块cloud-commons)
pom:
<dependencies> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.1.0</version> </dependency> </dependencies>
新建Payment实体类 和 统一返回格式类CommonResult
Payment类:
@Data @NoArgsConstructor @AllArgsConstructor public class Payment { private Long id; private String serial; }
要在数据库建立相应的字段:
CommonResult类:
@Data @NoArgsConstructor @AllArgsConstructor public class CommonResult<T> { private Integer code; //状态码 private String message; //状态说明 private T data; //传递数据 }
4、支付服务(服务提供者)(新建服务cloud-provider-payment8001)
pom文件:
<dependencies> <!--eureka-client--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <dependency> <groupId>com.cloud</groupId> <artifactId>cloud-commons</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.10</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</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>
yml:
server: port: 8001 spring: application: name: cloud-payment-service datasource: type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/cloud?useUnicode=true&characterEncoding=utf-8&useSSL=false username: root password: 123456 mybatis: mapperLocations: classpath:mapper/*.xml type-aliases-package: com.cloud.entities eureka: client: #表示是否将自己注册进EurekaServer默认为true register-with-eureka: true #是否从EurekaServer抓取已有的注册信息,默认为true。单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡 fetch-registry: true service-url: defaultZone: http://localhost:7001/eureka
dao:
@Mapper public interface PaymentDao { int create(Payment payment); Payment getPaymentById(@Param("id") Long id); }
service:
public interface PaymentService { public int create(Payment payment); public Payment getPaymentById(@Param("id") Long id); }
impl:
@Service public class PaymentServiceImpl implements PaymentService { @Resource private PaymentDao paymentDao; public int create(Payment payment){ return paymentDao.create(payment); } public Payment getPaymentById(Long id){ return paymentDao.getPaymentById(id); } }
controller:
@RestController @Slf4j public class PaymentController { @Resource private PaymentService paymentService; //只传给前端CommonResult,不需要前端了解其他的组件 @PostMapping(value = "/payment/create") public CommonResult create(Payment payment){ int result = paymentService.create(payment); log.info("*****插入结果:"+result); if(result > 0){ return new CommonResult(200,"插入数据成功",result); }else{ return new CommonResult(444,"插入数据失败",null); } } @GetMapping(value = "/payment/get/{id}") public CommonResult getPaymentById(@PathVariable("id") Long id){ Payment payment = paymentService.getPaymentById(id); log.info("*****插入结果:"+payment); if(payment != null){ return new CommonResult(200,"查询成功",payment); }else{ return new CommonResult(444,"没有对应记录,查询ID:"+id,null); } } }
mapper.xml
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.cloud.dao.PaymentDao"> <insert id="create" parameterType="com.commons.entity.Payment" useGeneratedKeys="true" keyProperty="id"> insert into payment(serial) values(#{serial}) </insert> <resultMap id="BaseResultMap" type="com.commons.entity.Payment"> <id column="id" property="id" jdbcType="BIGINT"/> <result column="serial" property="serial" jdbcType="VARCHAR"/> </resultMap> <select id="getPaymentById" parameterType="long" resultMap="BaseResultMap"> select * from payment where id=#{id}; </select> </mapper>
启动类:
@SpringBootApplication @EnableEurekaClient public class PaymentMain8001 { public static void main(String[] args) { SpringApplication.run(PaymentMain8001.class,args); } }
往数据库随便插入一条数据,启动访问http://localhost:8001/payment/get/1
查看eureka:
(注意:这里还没有加上@EnableDiscoveryClient注解,后面再说明)
5、订单服务(调用支付服务)(新建服务cloud-comsumer-order80)
pom:
<dependencies> <dependency> <groupId>com.cloud</groupId> <artifactId>cloud-commons</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <!--Eureka-client--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</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> </dependency> </dependencies>
yml:
spring: application: name: cloud-order-server eureka: client: #表示是否将自己注册进EurekaServer默认为true register-with-eureka: true fetch-registry: true service-url: defaultZone: http://localhost:7001/eureka server: port: 80
这里由于没有加入feign,所以使用自带的restTemplate进行远程通信设置配置类ApplicationContextConfig (向spring注入RestTemplate对象)
@Configuration public class ApplicationContextConfig { @Bean public RestTemplate getRestTemplate(){ return new RestTemplate(); } }
controller层(去调用支付模块的接口)
@RestController @Slf4j public class OrderController { //远程调用地址 private static final String PAYMENT_URL="http://localhost:8001"; @Resource private RestTemplate restTemplate; @GetMapping("/consumer/payment/create") public CommonResult<Payment> create(@RequestBody Payment payment){ return restTemplate.postForObject(PAYMENT_URL+"/payment/create",payment, CommonResult.class); } @GetMapping("/consumer/payment/get/{id}") public CommonResult<Payment> getPayment(@PathVariable("id") Long id){ return restTemplate.getForObject(PAYMENT_URL+"/payment/get/"+id,CommonResult.class); } }
启动类:
@SpringBootApplication @EnableEurekaClient public class OrderMain80 { public static void main(String[] args) { SpringApplication.run(OrderMain80.class,args); } }
启动:查看eureka:
访问http://localhost/consumer/payment/get/1
则远程调用成功
6、@EnableDiscoveryClient
启动类上添加注解
@EnableDiscoveryClient
或@EnableEurekaClient都可以让该服务注册到注册中心,被注册中心发现扫描,如果注册中心是eureka,使用EnableEurekaClient,如果注册中心是zk、consoul等,使EnableDiscoveryClient。
从Spring Cloud Edgware开始,
@EnableDiscoveryClient
或@EnableEurekaClient
可省略。只需加上相关依赖,并进行相应配置,即可将微服务注册到服务发现组件上。@EnableDiscoveryClient和@EnableEurekaClient共同点就是:都是能够让注册中心能够发现,扫描到改服务。
不同点:
@
EnableEurekaClient只适用于Eureka作为注册中心,@EnableDiscoveryClient
可以是其他注册中心。加上
@EnableDiscoveryClient注解可以获得服务列表信息
7、actuator微服务信息完善
两处的命名规范:
1、服务名称统一:
yml中:
instance: instance-id: payment8001
重启查看eureka:
此时关闭掉eureka的自我保护机制:在eureka服务端的yaml加上:
server: #关闭自我保护机制 enable-self-preservation: false
重启查看eureka:发现成功
2、鼠标放在服务名称上时,左下方显示ip地址
yml:加上prefer-ip-address: true 配置
instance: instance-id: payment8001 prefer-ip-address: true
重启查看eureka:
自我保护机制等原理后面系列的文章会讲到
8、搭建eureka集群和提供者集群
有人说为什么前面要写那么多业务代码?就是为了这里的集群用的。
1、搭建eureka集群:eureka的集群方式就是互相注册
新建eureka模块(cloud-eureka-server7002)
将7001的eureka服务的所有东西复制一份过来,然后修改两者的yml文件。
7001修改为:
server: port: 7001 eureka: instance: hostname: eureka7001 #eureka服务端实例名称 单机版 #hostname: eureka7001.com #eureka服务端实例名称 client: #表示不向注册中心注册自己 register-with-eureka: false #false表示自己就是注册中心,我的职责就是维护服务实例,并不区检索服务 fetch-registry: false service-url: #设置与Eureka server交互的地址查询服务和注册服务都需要依赖这个地址 #defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/ #单机版 defaultZone: http://eureka7002:7002/eureka/ #集群版 server: #关闭自我保护机制 enable-self-preservation: false
7002修改为:
server: port: 7002 eureka: instance: hostname: eureka7002 #eureka服务端实例名称 单机版 #hostname: eureka7001.com #eureka服务端实例名称 client: #表示不向注册中心注册自己 register-with-eureka: false #false表示自己就是注册中心,我的职责就是维护服务实例,并不区检索服务 fetch-registry: false service-url: #设置与Eureka server交互的地址查询服务和注册服务都需要依赖这个地址 #defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/ #单机版 defaultZone: http://eureka7001:7001/eureka/ #集群版 server: #关闭自我保护机制 enable-self-preservation: false
这里注意hostname一般是写IP地址(也可以不写ip地址,任意起名),由于是本机环境,无法模拟多个ip地址(都写127.0.0.1发现),所以在机器的host文件设置两个本地域名:
127.0.0.1 eureka7001 127.0.0.1 eureka7002
而defaultZone:指定服务注册中心的地址(指定ip/域名+端口)。这里如果不想去配置本地域名,可以用localhost代替(使用127.0.0.1不行)
重启两个服务:查看
这样就证明了集群搭建成功,如果是多个eureka,则在defaultZone后面多加一个注册地址,用逗号隔开。
此时在将两个服务的注册中心地址修改一下yml:(也可以用本地域名代替localhost)(加入集群的eureka)
defaultZone: http://localhost:7001/eureka,http://localhost:7002/eureka
此时不管访问哪个eureka都会注册两个服务:
------------------------------------------
2、建立提供者集群。
新建cloud-provider-payment8002模块,复制cloud-provider-payment8001的代码。
1、修改yml:
server: port: 8002 spring: application: name: cloud-payment-service datasource: type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/cloud?useUnicode=true&characterEncoding=utf-8&useSSL=false username: root password: 123456 mybatis: mapperLocations: classpath:mapper/*.xml type-aliases-package: com.cloud.entities eureka: client: #表示是否将自己注册进EurekaServer默认为true register-with-eureka: true #是否从EurekaServer抓取已有的注册信息,默认为true。单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡 fetch-registry: true service-url: defaultZone: http://localhost:7001/eureka,http://localhost:7002/eureka instance: instance-id: payment8002 prefer-ip-address: true
修改启动类名称,因为现在有两个提供者8001/8002,此时如果去请求不知道要负载均衡到哪个,由于eureka有集成ribbon组件,所以就用到ribbon的一个注解去帮我们负载均衡。
2、在调用者c的ApplicationContextConfig 中加上注解,则可以帮我们轮询负载
@Configuration public class ApplicationContextConfig { @LoadBalanced @Bean public RestTemplate getRestTemplate(){ return new RestTemplate(); } }
3、由于之前消费者的调用路径是写死的,此时要将其该为访问服务名路径
@RestController @Slf4j public class OrderController { //private static final String PAYMENT_URL="http://localhost:8001"; //通过在eureka上注册过的微服务名称调用 private static final String PAYMENT_URL = "http://cloud-payment-service"; @Resource private RestTemplate restTemplate; @GetMapping("/consumer/payment/create") public CommonResult<Payment> create(Payment payment){ return restTemplate.postForObject(PAYMENT_URL+"/payment/create",payment,CommonResult.class); } @GetMapping("/consumer/payment/get/{id}") public CommonResult<Payment> getPayment(@PathVariable("id") Long id){ return restTemplate.getForObject(PAYMENT_URL+"/payment/get/"+id,CommonResult.class); } }
4、为了分辨哪个端口提供给我们服务的,我们此时修改下两个服务的controller接口:
注入端口,在返回数据中加上端口数据。
此时重启所有服务:访问http://localhost/consumer/payment/get/1,不停的刷新,如果端口号出现变化则表示此时服务提供者集群搭建成功。
最后的情况是这样的:
下面对于eureka的配置信息做一些说明:
https://www.cnblogs.com/zhaoxiangjun/p/13039117.html
注意:eureka的AP体现在自我保护机制,zk的CP体现在临时有序节点。
至此eureka的基本操作就说完了。这里说明一下,这个系列只是对于springcloud组件的入门使用,对于一些原理如心跳机制、多级缓存、集群原理、自我保护机制等在其他文章统一说明。
由于nacos的强势出现,所以zk(注册、配置中心、分布式锁、全局id等)、consoul(可做注册中心、总线等多个功能)等注册中心虽然可以用,但还是推荐使用nacos。这里对于consoul组件就不在说明了。至于eureka,推荐还是不用,毕竟别人在进步,它却在停更。这里更多的是理解它的使用和原理+面试,其他的注册中心原理都是差不多的。
这里将代码放到github上:
1、在github上创建一个仓库用来存放代码,然后复制其地址https://github.com/wudixxxx/cloud.git
2、在代码的根目录打开git窗口,输入以下命令:
2.1:git init将该目录变成git可以管理的仓库
2.2:git add .
将文件添加到暂存区中,注意后面有个“.”,用空格隔开
2.3:git commit -m '描述内容'
将文件提交到git本地仓库
2.4:git remote add origin 远程github地址
此时是关联git远程仓库。
2.5:git pull --rebase origin master
将文件与远程仓库进行合并
出现fatal: Couldn't find remote ref master不用理会,因为此时你的远程厂库是空的不用合并。
2.6:git push -u origin master
真正的将代码推送到github上。(这里有窗口需要填写用户名密码等)
此时github上:
则上传成功
注意这里在和有代码的仓库合并时可能会出现冲突。
真实的项目中,你组长会给你创建一个远程分支(非master分支,例如dev-1),一般情况下你对远程的master分支没有操作权限的,此时你只需要把你的所有代码提到dev-1分支即可,你组长会根据你的dev-1分支代码进行合并。
而你每次提交代码时,都要先去pull你的分支上的最新代码(可能你的同事去改了你的代码)(这里可能会有冲突)
更新完本地仓库后,你则可以push你的代码上去。然后你组长会在你的分支上合并远程master分支代码,测试没问题了就会真正合并到master上。所以说到底你需要的工作是:
1、拿到你要传代码的分支。这里假如给你dev-1分支
2、pull拉取远程分支上的最新代码(有时需要解决冲突)
git pull origin master:dev-1 格式:git pull origin 本地分支名:远程分支名
不行就git pull origin dev-1
https://www.cnblogs.com/everfight/p/git_push_local_branch.html
解决冲突,会显示冲突文件,vim冲突文件进行修改就行,一般很少出现冲突的情况
3、push你的代码
git push origin master:dev-1
此时去查看你的分支就会发现代码上传成功
然后就没你事了,当然我们一般也在本地创建自己的分支用来接收远程的代码,例如创建本地分支dev,我们每次都用dev来接收远程的最新代码,然后在dev(同步过来的代码)上和master(自己开发的代码)进行合并并处理冲突,处理完后将其push到dev-1的远程分支
一般在工作中是不会使用github的,一般自建私有仓库gitlab
如果你是个小组员,那你基本按着github的步骤走就行。没有什么差别