springboot構建spring cloud 微服務項目搭建ARTHUR框架分享

時間 2019-11-15

標籤 springboot 構建 spring cloud 服務項目搭建 arthur 框架分享欄目 Spring 简体版

原文原文鏈接

在此分享下本人最近搭建的一個springcloud微服務項目，包括註冊中心、配置中心、熔斷器、turbine熔斷器集中監控中心、fegin、先後端負載均衡、swagger二、網關bus動態修改配置等等。項目只是初步搭建，以後還會加入各類好玩的技術，會不按期更新，感興趣的可下載進行研究交流，微服務的明天會更好。html

github前端

arthur https://github.com/ArthurFamily/arthur.git
config https://github.com/ArthurFamily/config-center.gitmysql

碼雲
https://git.oschina.net/ArthurFamily/arthur.git
https://git.oschina.net/ArthurFamily/config-center.gitgit

(注：配置文件經過git項目讀取，放到一個項目中讀取超過5分鐘纔會有響應，經測試不是網絡緣由，配置文件單獨放置一個項目沒有問題。)angularjs

<modules>
    <!-- 註冊中心與配置中心使用jhipster2.6.0 -->
    <module>arthur-eureka</module>
    <!-- 配置中心 -->
    <module>arthur-config-center</module>
    <!-- 集中監控斷路器儀表盤 -->
    <module>arthur-monitor-turbine</module>
    <!-- zuul網關 -->
    <module>arthur-gateway</module>
    <!-- 後臺管理之服務網管理 -->
    <module>arthur-manage-serviceWeb</module>
    <!-- 註冊流程 -->
    <module>arthur-manage-registrationProcess</module>
</modules>

最後兩個模塊主要作模塊間通信測試，沒有頁面，只是簡單的鏈接了數據庫，頁面以後會增長。github

註冊中心eureka主要使用的Jhipster的jhipster-registry-2.6.0版本，最新的版本3.1.0啓動異常，貌似是zuul的問題，故採用穩定版，頁面比原生的eureka頁面要美觀一些Jhipster抽空還會介紹，能夠生成微服務項目，可是前端採用的angularjs，還在入門，故想集成bootstrap框架，因此子項目本身搭建，只用它的註冊中心。若是須要搭建高可用集羣註冊中心，可部署多臺eureka進行以來註冊，也就是一般說的服務端的負載均衡。redis

1.首先介紹下配置中心 arthur-config-center，須要引入spring-cloud-config-serverspring

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
        <version>${springcloudconfig-version}</version>
        <exclusions>
            <exclusion>
                <artifactId>slf4j-api</artifactId>
                <groupId>org.slf4j</groupId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>
</dependencies>

加入EnableConfigServer註解sql

@SpringBootApplication
@EnableConfigServer
@EnableDiscoveryClient
public class ConfigCenter {

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

    public static void main(String[] args) throws UnknownHostException {
        SpringApplication app = new SpringApplication(ConfigCenter.class);
        //DefaultProfileUtil.addDefaultProfile(app);
        Environment env = app.run(args).getEnvironment();
        LOG.info("\n----------------------------------------------------------\n\t" +
                        "Application '{}' is running! Access URLs:\n\t" +
                        "Local: \t\thttp://127.0.0.1:{} \n\t" +
                        "External: \thttp://{}:{} \n\t" +
                        "Profile(s): \t{}\n----------------------------------------------------------",
                env.getProperty("spring.application.name")+"("+env.getProperty("version")+")",
                env.getProperty("server.port"),
                InetAddress.getLocalHost().getHostAddress(),
                env.getProperty("server.port"),
                env.getProperty("spring.profiles.active"));
    }
}

進行註冊，這裏採用的高可用配置中心，可部署多臺應用，而後依賴的項目跟進註冊中心的服務名去讀取各自的配置文件數據庫

# 註冊中心
eureka:
  client:
    enabled: true
    #註冊中心開啓健康檢查會刷新上下文
    healthcheck:
        enabled: false
    fetch-registry: true
    register-with-eureka: true
    instance-info-replication-interval-seconds: 10
    registry-fetch-interval-seconds: 10
    serviceUrl:
        defaultZone: http://${eurekaCenter.username}:${eurekaCenter.pasword}@localhost:8761/eureka/

配置Git

#配置中心 GitHub配置
cloud:
  config:
    server:
      git:
        uri: https://github.com/ArthurFamily/config-center.git
        search-paths: /config/dev
        strict-host-key-checking: false

啓動後訪問http://127.0.0.1:10002/arthur-manage-serviceWeb/dev，返回配置文件json，這裏有一個對應規則，對應配置文件中的{服務名-dev(profiles->active的名)},配置文件中放置數據庫、redis等配置

2.微服務項目 arthur-manage-serviceWeb 包括mybatis分頁插件，自動配置數據源，與arthur-manage-registration 經過fegin進行接口調用，swagger2，ribbon的使用等。

<dependencies>
    <!-- 自動配置，引入後，配置文件裏必須配置，用到再引入故不在父級放置 -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>${springboot-mybatis}</version>
        <exclusions>
            <exclusion>
                <artifactId>spring-boot</artifactId>
                <groupId>org.springframework.boot</groupId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
    <!-- 數據庫分頁插件 -->
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper-spring-boot-starter</artifactId>
        <version>LATEST</version>
    </dependency>
</dependencies>

公用的都在父級pom，部分以下fegin、hystrix、服務註冊發現的、讀取config的等

<!-- fegin 自帶斷路器-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
</dependency>
<!-- 斷路器 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-hystrix</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-eureka</artifactId>
    <version>${eureka-version}</version>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
    <version>${springcloudconfig-version}</version>
    <exclusions>
        <exclusion>
            <artifactId>spring-boot</artifactId>
            <groupId>org.springframework.boot</groupId>
        </exclusion>
    </exclusions>
</dependency>

mybatis-spring-boot-starter會自動讀取配置文件中的數據源配置，無需咱們本身去實現建立datasource、sqlsessionfactory等

spring:
  application:
    name: arthur-manage-serviceWeb
  profiles:
    active: dev
  output:
    ansi:
      enabled: ALWAYS
  jackson:
    default-property-inclusion: non_null
  cloud:
    config:
      discovery:
        enabled: true
        service-id: arthur-config-center

注意@MapperScan掃描mapper接口，原生的baseMapper不能被掃描到，故本身建立，掃描mapper配置文件在application.yml中

# mybatis mapper 文件
mybatis:
  mapper-locations: classpath:mapper/**/*.xml

@EnableDiscoveryClient啓用註冊發現，@EnableFeignClients啓用fegin調用

@SpringBootApplication
@Import({WebMvcConfig.class})
@EnableScheduling
@ServletComponentScan
@RestController
@MapperScan(value = "**.mapper", markerInterface = BaseMapper.class)
@EnableDiscoveryClient
@EnableFeignClients // 調用服務
@EnableHystrix
public class ManageServiceWeb {

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

    public static void main(String[] args) throws UnknownHostException {
        SpringApplication app = new SpringApplication(ManageServiceWeb.class);
        //DefaultProfileUtil.addDefaultProfile(app);
        Environment env = app.run(args).getEnvironment();
        LOG.info("\n----------------------------------------------------------\n\t" +
                        "Application '{}' is running! Access URLs:\n\t" +
                        "Local: \t\thttp://127.0.0.1:{} \n\t" +
                        "External: \thttp://{}:{} \n\t" +
                        "Profile(s): \t{}\n----------------------------------------------------------",
                env.getProperty("spring.application.name")+"("+env.getProperty("version")+")",
                env.getProperty("server.port"),
                InetAddress.getLocalHost().getHostAddress(),
                env.getProperty("server.port"),
                env.getProperty("spring.profiles.active"));
    }

分頁插件的使用

引入pom後在application.yml中增長配置

#分頁插件使用
pagehelper:
   helperDialect: mysql
   reasonable: true
   supportMethodsArguments: true
   params: count=countSql

在調用數據庫查詢以前增長

public List<Users> getUserList(int page, int pageSize) {

    PageHelper.startPage(page, pageSize);
    return usersMapper.getUserList();
}

只對跟隨在PageHelper以後的一條查詢有效，PageInfo中有本身須要的page，limit等

@ApiOperation("獲取用戶分頁列表")
@ApiImplicitParam(name = "offset", value = "當前頁數", required = true, dataType = "int", paramType = "query")
@RequestMapping(value = "/getUserList", method = RequestMethod.GET)
public Object getUserList(int offset) {

    // 分頁經過request傳入參數
    // PageHelper.offsetPage(offset, 1);

    return new PageInfo(usersService.getUserList(offset,2));
}

下面再說一下fegin，自帶ribbon前端負載均衡，其實就是封裝了一下http請求，包括請求頭一些數據，本身也能夠經過實現接口類去自定義，首先使用@EnableFeignClients啓用，而後建立接口，本身項目中就能夠經過@Autowired直接注入使用了

@FeignClient(value = "arthur-manage-registrationProcess")
public interface RegistrationProcessFeignService {

    @RequestMapping(value = "/test/{name}", method = RequestMethod.GET)
    public String getServiceName(@PathVariable(value = "name") String name);
}

就會調用 arthur-manage-registrationProcess中的test方法，返回想要的信息

@RequestMapping(value = "/test/{name}", method = RequestMethod.GET)
public String getServiceName(@PathVariable(value = "name") String name) {

    return "請求者：" + name + "請求arthur-manage-registrationProcess的test方法";
}

而後就是swagger2，能夠幫助咱們進行接口測試同時幫助咱們維護API

公用的在父級

<!-- swagger支持 每一個項目經過註冊中心的實例點擊進入swagger頁面 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

而後經過spring幫咱們配置swagger，經過@EnableSwagger2啓用

/**
 * 提供接口的服務須要引入此配置.
 * eureka中home-page-url配置http://localhost:${server.port}/swagger-ui.html地址，經過註冊中心直接點擊進入頁面
 * Created by chenzhen on 2017/8/4.
 */
@Configuration
@EnableSwagger2 // 啓用Swagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {// 建立API基本信息
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cloud.arthur.controller"))// 掃描該包下的全部須要在Swagger中展現的API，@ApiIgnore註解標註的除外
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {// 建立API的基本信息，這些信息會在Swagger UI中進行顯示
        return new ApiInfoBuilder()
                .title("ARTHUR-MANAGE-SERVICEWEB 接口 APIs")// API 標題
                .description("服務端管理模塊對外暴露接口API")// API描述
                .contact("chenzhen@163.com")// 聯繫人
                .version("1.0")// 版本號
                .build();
    }
}

而後要在本身的controller中對方法進行註釋，必定要指定method類型，不然全部種類的http方法都會建立一遍，也可用@GetMapping@postMapping@PutMapping等註解，無需指定，這裏類型還要對應API註解中的paramType，如get方法對應query

@ApiIgnore
@RequestMapping("/hello")
public String hello(String name) {
    return registrationProcessFeginService.getServiceName(name);
}

@ApiOperation("根據name獲取用戶信息")
@ApiImplicitParam(name = "name", value = "用戶名稱", required = true, dataType = "String", paramType = "query")
@RequestMapping(value = "/getName", method = RequestMethod.GET)
public Users getName(String name) {
    return usersService.getUserByName(name);
}

@ApiOperation("獲取用戶分頁列表")
@ApiImplicitParam(name = "offset", value = "當前頁數", required = true, dataType = "int", paramType = "query")
@RequestMapping(value = "/getUserList", method = RequestMethod.GET)
public Object getUserList(int offset) {

    // 分頁經過request傳入參數
    // PageHelper.offsetPage(offset, 1);

    return new PageInfo(usersService.getUserList(offset,2));
}

經過http://localhost:${server.port}/swagger-ui.html訪問頁面，這裏能夠經過配置註冊中心的home-page-url，直接從註冊中心點擊進入swagger頁面，項目多了維護起來也方便

# 註冊中心
eureka:
  client:
    enabled: true
    #此處開啓健康檢查與高可用配置中心衝突，不可並存
    healthcheck:
        enabled: false
    fetch-registry: true
    register-with-eureka: true
    instance-info-replication-interval-seconds: 10
    registry-fetch-interval-seconds: 10
    serviceUrl:
        defaultZone: http://${eurekaCenter.username}:${eurekaCenter.pasword}@localhost:8761/eureka/
  instance:
      appname: ${spring.application.name}
      instanceId: ${spring.application.name}:${spring.application.instance-id:${random.value}:${server.port}}
      lease-renewal-interval-in-seconds: 5
      lease-expiration-duration-in-seconds: 10
      metadata-map:
          zone: primary
          profile: ${spring.profiles.active}
          version: ${info.project.version}
      #配置swagger地址經過註冊重點點擊進入
      home-page-url: http://localhost:${server.port}/swagger-ui.html

3.斷路器使用

<!-- 斷路器 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-hystrix</artifactId>
</dependency>

經過@EnableHystrix啓用熔斷器

而後須要熔斷的方法中本身實現一個方法，feign中直接實現本身的fegin接口就能夠了，而後進行異常處理，fallback指向實現類。

@RequestMapping("/tests")
@HystrixCommand(fallbackMethod = "getNameFail")
public String getName() {

    String a = null;
    a.length();
    return "success";
}

public String getNameFail() {

    return "fail";
}

其實如今再加入@EnableHystrixDashboard,經過http://127.0.0.1:10004/hystrix訪問頁面添加/hystrix/hystrix.stream就能夠監控了，可是隻能監控本身，因此咱們須要一個集羣監控，故此採用turbine

下面看一下arthur-monitor-turbine項目

<dependencies>
    <!-- 監控斷路器總大盤 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-turbine</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-netflix-turbine</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-hystrix-dashboard</artifactId>
    </dependency>
</dependencies>

經過@EnableTurbine啓用turbine@EnableHystrixDashboard啓用頁面大盤

@SpringBootApplication
@EnableDiscoveryClient
@EnableTurbine
@EnableHystrixDashboard
public class MonitorTurbine {

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

    public static void main(String[] args) throws UnknownHostException {
        SpringApplication app = new SpringApplication(MonitorTurbine.class);
        //DefaultProfileUtil.addDefaultProfile(app);
        Environment env = app.run(args).getEnvironment();
        LOG.info("\n----------------------------------------------------------\n\t" +
                        "Application '{}' is running! Access URLs:\n\t" +
                        "Local: \t\thttp://127.0.0.1:{} \n\t" +
                        "External: \thttp://{}:{} \n\t" +
                        "Profile(s): \t{}\n----------------------------------------------------------",
                env.getProperty("spring.application.name")+"("+env.getProperty("version")+")",
                env.getProperty("server.port"),
                InetAddress.getLocalHost().getHostAddress(),
                env.getProperty("server.port"),
                env.getProperty("spring.profiles.active"));
    }
}

集中配置文件中配置須要監控的服務的名稱，這些服務都得啓用@EnableHystrix並配置fallback

turbine:
  aggregator:
    clusterConfig: default   # 指定聚合哪些集羣，多個使用","分割，默認爲default。可以使用http://.../turbine.stream?cluster={clusterConfig之一}訪問
  appConfig: arthur-manage-registrationProcess,arthur-manage-serviceWeb  # 配置Eureka中的serviceId列表，代表監控哪些服務
  clusterNameExpression: new String("default")
  # 1. clusterNameExpression指定集羣名稱，默認表達式appName；此時：turbine.aggregator.clusterConfig須要配置想要監控的應用名稱
  # 2. 當clusterNameExpression: default時，turbine.aggregator.clusterConfig能夠不寫，由於默認就是default
  # 3. 當clusterNameExpression: metadata['cluster']時，假設想要監控的應用配置了eureka.instance.metadata-map.cluster: ABC，則須要配置，同時turbine.aggregator.clusterConfig: ABC
#前端負載配置

啓動後可看到監控的stream

訪問http://127.0.0.1:10004/hystrix，並寫入turbine的stream http://127.0.0.1:10004/turbine.stream

訪問熔斷器方法http://127.0.0.1:10003/tests，就能夠看到大盤了

4.網關zuul的使用 arthur-gateway

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-zuul</artifactId>
    </dependency>
</dependencies>

@EnableZuulProxy啓用網關代理@SpringCloudApplication包含@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker這仨註解

@SpringCloudApplication
@EnableZuulProxy
public class GateWay {

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

    public static void main(String[] args) throws UnknownHostException {
        SpringApplication app = new SpringApplication(GateWay.class);
        //DefaultProfileUtil.addDefaultProfile(app);
        Environment env = app.run(args).getEnvironment();
        LOG.info("\n----------------------------------------------------------\n\t" +
                        "Application '{}' is running! Access URLs:\n\t" +
                        "Local: \t\thttp://127.0.0.1:{} \n\t" +
                        "External: \thttp://{}:{} \n\t" +
                        "Profile(s): \t{}\n----------------------------------------------------------",
                env.getProperty("spring.application.name")+"("+env.getProperty("version")+")",
                env.getProperty("server.port"),
                InetAddress.getLocalHost().getHostAddress(),
                env.getProperty("server.port"),
                env.getProperty("spring.profiles.active"));
    }

    @Bean
    public GatewayFilter gatewayFilter() {
        return new GatewayFilter();
    }

建立一個zuulfilter，接收請求的時候首先去校驗參數中是否包含咱們配置的tocken，包含才繼續請求，增強安全認證

public class GatewayFilter extends ZuulFilter{

    @Value("${spring.accessToken}")
    private String accessToken;

    @Override
    public boolean shouldFilter() {
        return true;
    }

    /*filterType：返回一個字符串表明過濾器的類型，在zuul中定義了四種不一樣生命週期的過濾器類型，具體以下：
        pre：能夠在請求被路由以前調用
        routing：在路由請求時候被調用
        post：在routing和error過濾器以後被調用
        error：處理請求時發生錯誤時被調用
        filterOrder：經過int值來定義過濾器的執行順序
        shouldFilter：返回一個boolean類型來判斷該過濾器是否要執行，因此經過此函數可實現過濾器的開關。在上例中，咱們直接返回true，因此該過濾器老是生效。
        run：過濾器的具體邏輯。須要注意，這裏咱們經過ctx.setSendZuulResponse(false)令zuul過濾該請求，不對其進行路由，而後經過ctx.setResponseStatusCode(401)設置了其返回的錯誤碼，固然咱們也能夠進一步優化咱們的返回，好比，經過ctx.setResponseBody(body)對返回body內容進行編輯等。
        */
    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        Object accessToken = request.getParameter("accessToken");  //定義規則：訪問url中必須帶有accessToken參數
        if(accessToken == null || !accessToken.equals(accessToken)) {
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            return null;
        }
        return null;

    }

    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 0;
    }

而後配置網關代理

#develop
# zuul配置
zuul:
    host:
        max-total-connections: 1000
        max-per-route-connections: 100
    semaphore:
        max-semaphores: 500
    routes:
        api-a:
          path: /services/**
          # 提供服務的名稱，對外接口，需提供token
          serviceId: arthur-manage-serviceWeb
spring:
  accessToken: 1000010121385750333

最後經過網關服務器就能夠訪問註冊服務提供的方法了

以前訪問http://127.0.0.1:10001/getUserList?offset=1

如今訪問http://127.0.0.1:9999/services/getUserList?offset=1&accessToken=1000010121385750333 一樣的效果

最後就能夠同步進行開發了。