Spring Cloud+ Eureka微服務基礎專案搭建（已實現呼叫增刪改查微服務，持續更新）

Jake Weng發表於2019-02-21

O、Spring Cloud Eureka概念

Spring Cloud Eureka是什麼？

Spring Cloud Eureka是Spring Cloud Netflix微服務套件中的一部分，它基於Netflix
Eureka做了二次封裝，主要負責完成微服務架構中的服務治理功能。Spring Cloud通過為Eureka增加了Spring
Boot風格的自動化配置，我們只需通過簡單引入依賴和註解配置就能讓Spring
Boot構建的微服務應用輕鬆地與Eureka服務治理體系進行整合。

關於Eureka的更多理論，可以參考《Spring Cloud微服務實戰》第3章內容。

一、IntelliJ IDEA搭建並測試專案

本專案是一個多模組專案，每個獨立功能被抽取為一個Module，這樣便於在IntelliJ IDEA中管理專案，避免了在不同的Project視窗來回切換。

1.1 新建空工程

新建空工程，命名為eureka-mall
在這裡插入圖片描述

1.2 搭建公共實體類模組

新建一個Module，命名為mall-crud，引入Lombok依賴。
其中的實體類來自我的博文《SpringBoot+MySQL+MyBatis（Mapper.xml方式）實現簡單的多表CRUD（RESTful風格HTTP介面）》
User.java

package com.jake.mallmodel.entity;

import lombok.Data;

@Data
public class User {

    private Integer uid;

    private String username;

    private String password;

}

UserInfo.java

package com.jake.mallmodel.entity;

import lombok.Data;

import java.util.List;

@Data
public class UserInfo {

    private List<User> users;

    private String cname;

    private String city;

}

1.3 搭建增刪改查模組

此模組是Eureka的服務之一，對外提供User和UserInfo的增刪改查操作，其CRUD三層架構程式碼也來自我的博文《SpringBoot+MySQL+MyBatis（Mapper.xml方式）實現簡單的多表CRUD（RESTful風格HTTP介面）》，可以在IntelliJ IDEA中直接引入已存在的模組：
在這裡插入圖片描述
修改專案名為mall-crud（同時也修改包名），刪除實體類，並在pom檔案中（1）引入Eureka Server相關的依賴，（2）引入mall-model專案依賴，以便於匯入User和UserInfo實體類：
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.jake</groupId>
    <artifactId>mall-crud</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>mall-crud</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.0</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.54</version>
        </dependency>

        <dependency>
            <groupId>com.jake</groupId>
            <artifactId>mall-model</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

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

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
    </repositories>

</project>

application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/eureka-db?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
    username: root
    password: 123
    driver-class-name: com.mysql.cj.jdbc.Driver
  application:
    name: mall-crud
mybatis:
  mapper-locations: classpath:mapper/*xml
server:
  port: 8083
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8081/eureka/

在啟動類上加入@EnableEurekaClient註解，標誌這是Eureka客戶端，可以將自身註冊到服務端上。

package com.jake.eurekaclient;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

@SpringBootApplication
@EnableEurekaClient
public class EurekaClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(EurekaClientApplication.class, args);
    }

}

為了方便與後面Eureka客戶端呼叫介面的程式碼比較，在此處貼出CRUD介面所在控制層的程式碼：

package com.jake.mallcrud.controller;

import com.jake.mallcrud.service.UserService;
import com.jake.mallmodel.entity.User;
import com.jake.mallmodel.entity.UserInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("users")
public class UserController {

    @Autowired
    private UserService userService;

    /**
     * 查詢所有使用者
     * @return
     */
    @GetMapping
    public List<User> findAllUsers() {
        return userService.findAllUsers();
    }

    /**
     * 查詢所有使用者資訊
     * @return
     */
    @GetMapping("info")
    public List<User> findAllUserInfo() {
        return userService.findAllUserInfo();
    }

    /**
     * 通過id查詢使用者
     * @param uid
     * @return
     */
    @GetMapping("{uid}")
    public User findUserById(@PathVariable Integer uid) {
        return userService.findUserById(uid);
    }

    /**
     * 通過id查詢使用者資訊
     * @param uid
     * @return
     */
    @GetMapping("info/{uid}")
    public UserInfo findUserInfoById(@PathVariable Integer uid) {
        return userService.findUserInfoById(uid);
    }

    /**
     * 通過使用者名稱和公司名查詢使用者
     * @param username
     * @param cname
     * @return
     */
    @GetMapping("info/{cname}/{username}")
    public List<UserInfo> findUserInfoByUsernameAndCname(@PathVariable String username, @PathVariable String cname) {
        return userService.findUserInfoByUsernameAndCname(username, cname);
    }

    /**
     * 新增使用者
     * @param user
     * @return
     */
    @PostMapping
    public String createUser(@RequestBody User user) {
        if (user != null) {
            userService.createUser(user);
            return "新增使用者成功";
        } else {
            return "新增使用者失敗";
        }
    }

    /**
     * 修改使用者
     * @param user
     * @return
     */
    @PutMapping
    public String updateUser(@RequestBody User user) {
        User userInDb = userService.findUserById(user.getUid());
        if (userInDb != null) {
            userService.updateUser(user);
            return "更新使用者成功";
        } else {
            return "更新使用者失敗";
        }
    }

    /**
     * 刪除使用者
     * @param uid
     * @return
     */
    @DeleteMapping("{uid}")
    public String removeUserById(@PathVariable Integer uid) {
        User user = userService.findUserById(uid);
        if (user == null) {
            return "資料庫中不存在id為" + uid + "的使用者";
        } else {
            userService.removeUserById(uid);
            return "刪除成功";
        }
    }

}

1.4 搭建Eureka服務端

Eureka服務端是一個服務註冊和發現中心，並可以通過心跳檢測時刻更新微服務的註冊資訊。
新建一個Module，命名為eureka-server，在Dependencies中選擇Cloud Discovery，建立好工程：
在這裡插入圖片描述
在啟動類上加入@EnableEurekaServer註解，標記這是Eureka服務端：

package com.jake.eurekaserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@SpringBootApplication
@EnableEurekaServer
public class EurekaServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(EurekaServerApplication.class, args);
    }

}

application.yml中做如下配置：

server:
  port: 8081
eureka:
  instance:
    hostname: eureka-server
  client:
    register-with-eureka: false
    fetch-registry: false
    service-url:
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

其中配置檔案中各個變數的作用可通過檢視原始碼的註釋瞭解。

1.5 搭建Eureka客戶端

新建模組，選擇的Dependencies如下圖：
在這裡插入圖片描述
此模組用於測試，可以呼叫其他註冊到Eureka Server的服務提供的介面，同時其自身也是一個服務。本文中用於呼叫mall-crud提供的CRUD介面。
application.yml：

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8081/eureka/
server:
  port: 8082
spring:
  application:
    name: eureka-client

配置RestTemplate的Bean物件：

package com.jake.eurekaclient.config;

import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class RestConfig {

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

}

記得在啟動類上加入@EnableEurekaClient註解。
測試mall-crud專案介面用的控制層：

package com.jake.eurekaclient.controller;

import com.jake.mallmodel.entity.User;
import com.jake.mallmodel.entity.UserInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.client.RestTemplate;

import java.util.List;

@RestController
@RequestMapping("users")
@SuppressWarnings("unchecked")
public class UserController {

    @Autowired
    private RestTemplate restTemplate;

    private static final String MALL_CRUD_USERS_URL = "http://mall-crud/users/";

    @GetMapping
    public List<User> getUsers() {
        List<User> users = restTemplate.getForObject(MALL_CRUD_USERS_URL, List.class);
        return users;
    }

    @GetMapping("info")
    public List<UserInfo> getAllUserInfo() {
        List<UserInfo> allUserInfo = restTemplate.getForObject(MALL_CRUD_USERS_URL + "info/", List.class);
        return allUserInfo;
    }

    @GetMapping("{uid}")
    public User getUserById(@PathVariable Integer uid) {
        User user = restTemplate.getForObject(MALL_CRUD_USERS_URL + uid, User.class);
        return user;
    }

    @GetMapping("info/{uid}")
    public UserInfo getUserInfoById(@PathVariable Integer uid) {
        UserInfo userInfo = restTemplate.getForObject(MALL_CRUD_USERS_URL + "info/" + uid, UserInfo.class);
        return userInfo;
    }

    @GetMapping("info/{cname}/{username}")
    public List<UserInfo> getUserInfoByUsernameAndCname(@PathVariable String username, @PathVariable String cname) {
        List<UserInfo> userInfoList = restTemplate.getForObject(MALL_CRUD_USERS_URL + "info/" + cname + "/" + username, List.class);
        return userInfoList;
    }

    @PostMapping
    public String addUser(@RequestBody User user) {
        String msg = restTemplate.postForObject(MALL_CRUD_USERS_URL, user, String.class);
        return msg;
    }

    @PutMapping
    public void updateUser(@RequestBody User user) {
        restTemplate.put(MALL_CRUD_USERS_URL, user);
    }

    @DeleteMapping("{uid}")
    public void deleteUserById(@PathVariable Integer uid) {
        restTemplate.delete(MALL_CRUD_USERS_URL + uid);
    }

}

其中實體類User來自專案mall-model，從URL可知，此客戶端要呼叫的是mall-crud的RESTFUL介面，獲取使用者資料。
注：此處有個缺陷：restTemplate的put和delete方法的型別為void，所以訪問eureka-client的新增和刪除介面沒有獲取mall-crud介面的提示資訊，並返回給前端。

二、測試Eureka微服務呼叫

2.1 訪問Eureka後臺管理頁面

在瀏覽器中輸入：localhost:8081，可進入Eureka Server主頁
在這裡插入圖片描述
由頁面資訊可知，eureka-client（8082）和mall-crud（8083）已註冊到Eureka Server，兩者可以獲取對方的註冊資訊，並相互訪問介面，本文中，我們通過postman測試eureka-client（8082）來訪問mall-crud（8083）的CRUD介面。

2.2 Postman測試CRUD介面

2.2.1 查詢使用者

HTTP請求方式選為GET
localhost:8082/users
localhost:8082/users/info
localhost:8082/users/1
localhost:8082/users/info/admin.com/admin

2.2.2 新增使用者

HTTP請求方式選為POST，請求頭選為Content-Type：application/json
localhost:8082/users/

{
	"username": "Jason Tang",
	"uid": 10
}

2.2.3 更新使用者

HTTP請求方式選為PUT，請求頭選為Content-Type：application/json
localhost:8082/users/

{
	"username": "Jason.Tang",
	"uid": 10
}

2.2.4 刪除使用者

HTTP請求方式選為DELETE
localhost:8082/users/10

Eureka實現微服務的呼叫
2018-09-10
微服務
Go微服務實踐之增刪改查
2020-12-08
Go微服務
Eureka-實現微服務的呼叫
2019-03-19
微服務
【Spring Cloud】Eureka實現微服務釋出與呼叫
2019-01-31
SpringCloud微服務
Spring Cloud微服務-基於Eureka的feign呼叫(1)
2019-03-26
SpringCloud微服務
Eureka的微服務之間呼叫
2019-12-25
微服務
Go微服務框架go-kratos實戰03：使用 gorm 實現增刪改查操作
2022-06-02
Go微服務框架ORM
Eureka微服務之間呼叫-feign
2020-01-01
微服務
微服務之Eureka服務發現
2018-12-10
微服務
（十七）spring cloud微服務分散式雲架構-eureka 基礎
2019-03-13
SpringCloud微服務分散式架構
GO 微服務周邊服務持續整合
2019-08-21
Go微服務
Spring Cloud微服務基礎元件實戰
2019-05-06
SpringCloud微服務元件
微服務、容器與持續交付
2017-10-12
微服務
二、Spring Cloud 之旅 -- Eureka 微服務的釋出與呼叫
2019-03-03
SpringCloud微服務
微服務~Eureka實現的服務註冊與發現及服務之間的呼叫
2017-09-26
微服務
微服務基礎
2022-04-18
微服務
第2章實現突破——持續部署、微服務和容器
2018-11-07
微服務
Spring Cloud 微服務專案實現總架構一
2018-12-28
SpringCloud微服務架構
微服務容器部署與持續整合
2020-08-07
微服務
微服務化的基石——持續整合
2018-04-26
微服務
Spring Cloud之微服務之間相互呼叫、如何讓一個微服務呼叫另外一個微服務
2019-05-30
SpringCloud微服務
【微服務之Eureka服務註冊發現】
2018-02-15
微服務
持續部署微服務的實踐和準則
2017-03-17
微服務
基於OpenTelemetry實現Java微服務呼叫鏈跟蹤
2024-02-19
Java微服務
微服務呼叫鏈追蹤中心搭建
2019-02-28
微服務
spring微服務實戰(二):使用Spring Boot建立微服務
2017-09-07
微服務Spring Boot
微服務下的持續整合-Jenkins自動化部署GitHub專案
2020-11-19
微服務JenkinsGithub
golang 微服務-基礎元件
2019-12-25
Golang微服務元件
微服務基礎知識
2021-07-16
微服務
SpringCloud微服務基礎
2018-09-29
SpringGCCloud微服務
使用Spring Boot實現微服務架構的開源專案
2018-10-14
Spring Boot微服務架構
優效學院基於微服務的秒殺專案實戰 Spring Boot 2.0基礎
2021-09-09
微服務Spring Boot
SQL 基礎增、刪、改、查
2018-08-22
SQL
微服務專案實踐之中建專案
2018-12-07
微服務
129、springcloud-eureka-client微服務的互相呼叫
2020-04-02
SpringGCCloudclient微服務
SpringCloud微服務專案搭建與部署教程
2020-10-18
SpringGCCloud微服務
day03-搭建微服務基礎環境02
2023-04-04
微服務
springcloud 微服務之 Eureka 配置
2020-08-12
SpringGCCloud微服務