spring cloud（一）

一、项目结构说明

demo的github地址：git clone -b v1 https://github.com/XHxin/demo-spring-cloud.git
整个项目分为以下五个模块：
demo-common 公共模块，用于存放一些公共内容，例如实体类
demo-provider-product 产品服务的生产者（真实项目可能还存在其他服务，例如订单服务等）
demo-consumer 消费者，服务的调用方
demo-eureka 注册中心（类似zookeeper）
demo-security 安全模块（我们提供的服务，例如产品服务可能是在公网网络下提供服务的，所以可不能让谁都能调用，需要做安全认证）

数据库脚本：

CREATE DATABASE springcloud CHARACTER SET UTF8 ;
USE springcloud ;
CREATE TABLE product (
prodcutId BIGINT AUTO_INCREMENT ,
productName VARCHAR(50) ,
 productDesc VARCHAR(50) ,
CONSTRAINT pk_prodcut_id PRIMARY KEY(prodcutId)
) ;

INSERT INTO product(productName,productDesc) VALUES ('电视机',DATABASE()) ;
INSERT INTO product(productName,productDesc) VALUES ('笔记本电脑',DATABASE()) ;
INSERT INTO product(productName,productDesc) VALUES ('平板',DATABASE()) ;
INSERT INTO product(productName,productDesc) VALUES ('电水壶',DATABASE()) ;
INSERT INTO product(productName,productDesc) VALUES ('电冰箱',DATABASE()) ;

二、开始项目搭建

2.1 新建一个maven项目并命名为demo-spring-cloud

新建一个maven项目，项目名为demo-spring-cloud，此项目作为一个总项目，后面在此项目下新建五个子模块。
demo-spring-cloud项目的pom文件如下

<?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.nelson.org</groupId>
    <artifactId>demo-spring-cloud</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <jdk.version>1.8</jdk.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <dependencyManagement>
        <dependencies>
            <dependency> <!-- 进行SpringCloud依赖包的导入处理 -->
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency> <!-- SpringCloud离不开SpringBoot，所以必须要配置此依赖包 -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.1.2.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.0.31</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.0</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <build>
        <finalName>demo-spring-cloud</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>${jdk.version}</source><!-- 源代码使用的开发版本 -->
                    <target>${jdk.version}</target><!-- 需要生成的目标class文件的编译版本 -->
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

spingcloud中针对依赖包的版本并不像传统项目一样使用的是数字形式定义，反而是使用了一系列英国的地铁或者城市名字来定义，springcloud使用了springboot，其中对于的版本如下
Release Train Boot Version
Greenwich 2.1.x
Finchley 2.0.x
Edgware 1.5.x
Dalston 1.5.x

2.2 新建一个子模块demo-common

简历一个公共模块(maven项目)，这个模块的主要功能是提供公共处理的工具类、实体、接口等。
pom文件如下，在pom文件中为此模块添加上版本信息

<?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">
    <parent>
        <artifactId>demo-spring-cloud</artifactId>
        <groupId>com.nelson.org</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>demo-common</artifactId>
    **<version>1.0.0</version>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>**
</project>

实体对象不管是服务提供者还是消费者都需要用到，所以把实体对象创建到demo-common模块中。

package com.nelson.org.entity;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-20 14:45
 * @todo
 */
public class Product {
    private Long productId;
    private String productName;
    private String productDesc;

    public String getProductDesc() {
        return productDesc;
    }
    public void setProductDesc(String productDesc) {
        this.productDesc = productDesc;
    }
    public String getProductName() {
        return productName;
    }
    public void setProductName(String productName) {
        this.productName = productName;
    }
    public Long getProductId() {
        return productId;
    }
    public void setProductId(Long productId) {
        this.productId = productId;
    }
    @Override
    public String toString() {
        return "Product{" +
                "productId=" + productId +
                ", productName='" + productName + '\'' +
                ", productDesc='" + productDesc + '\'' +
                '}';
    }
}

2.3 新建一个子模块demo-provider-product，作为服务的提供者

此模块使用mybatis对数据库进行操作，pom文件如下，在pom文件中引入了demo-common模块，并为demo-provider-product模块提供了一个版本号。

<?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">
    <parent>
        <artifactId>demo-spring-cloud</artifactId>
        <groupId>com.nelson.org</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>demo-provider-product</artifactId>
    
    <version>1.0.0</version>

    <dependencies>
        <dependency>
            <groupId>com.nelson.org</groupId>
            <artifactId>demo-common</artifactId>
            <version>1.0.0</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</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-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>


</project>

引入其他模块后最好重新导入一下依赖，不然可能引用不了

在demo-provider-product模块创建一个ProductMapper对数据库操作

package com.nelson.org.mapper;

import com.nelson.org.entity.Product;

import java.util.List;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-20 14:56
 * @todo
 */
public interface ProductMapper {
    boolean create(Product product);
    public Product findById(Long id);
    public List<Product> findAll();
}

为demo-provider-product项目添加一个yml文件，并在yml文件中添加上数据库连接信息，注意把com.nelson.org.mapper该成你的mapper的路径。

server:
  port: 8080
mybatis:
 mapper-locations: # 所有的mapper映射文件
 - classpath:mapping/*.xml
spring:
 datasource:
   type: com.alibaba.druid.pool.DruidDataSource # 配置当前要使用的数据源的操作类型
   driver-class-name: com.mysql.cj.jdbc.Driver # 配置MySQL的驱动程序类
   url: jdbc:mysql://localhost:3306/springcloud?serverTimezone=GMT%2B8 # 数据库连接地址
   username: root # 数据库用户名
   password: aimashi620

logging:
  level:
    com.nelson.org.mapper: debug

创建ProductMapper.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.nelson.org.mapper.ProductMapper">
    <select id="findById" resultType="com.nelson.org.entity.Product" parameterType="long">
        select productId,productName,productDesc from product WHERE productId=#{id} ;
    </select>
    <select id="findAll" resultType="com.nelson.org.entity.Product">
        SELECT productId,productName,productDesc from product;
    </select>
    <insert id="create" parameterType="com.nelson.org.entity.Product">
        INSERT INTO product(productName,productDesc) VALUES (#{productName},database()) ;
    </insert>
</mapper>

创建IProductService接口与实现类

package com.nelson.org.service;

import com.nelson.org.entity.Product;

import java.util.List;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-11 14:50
 * @todo
 */
public interface IProductService {
    Product get(long id);
    boolean add(Product product);
    List<Product> list();
}

package com.nelson.org.service.impl;

import com.nelson.org.entity.Product;
import com.nelson.org.mapper.ProductMapper;
import com.nelson.org.service.IProductService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.List;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-11 15:22
 * @todo
 */


@Service
public class ProductServiceImpl implements IProductService {

    @Resource
    private ProductMapper productMapper;

    @Override
    public Product get(long id) {
        return productMapper.findById(id);
    }

    @Override
    public boolean add(Product product) {
        return productMapper.create(product);
    }

    @Override
    public List<Product> list() {
        return productMapper.findAll();
    }
}

创建demo-provider-product项目的启动类，并定义好mapper扫描包

package com.nelson.org;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-20 15:18
 * @todo
 */
@SpringBootApplication
@MapperScan("com.nelson.org.mapper")
public class ProductApplication {
    public static void main(String[] args) {
        SpringApplication.run(ProductApplication.class);
    }
}

编写单元测试，保证服务提供方没问题

package com.nelson.org;

import com.nelson.org.ProductApplication;
import com.nelson.org.entity.Product;
import com.nelson.org.service.IProductService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-11 16:13
 * @todo
 */
@SpringBootTest(classes = ProductApplication.class)
@RunWith(SpringRunner.class)
public class ProductServiceTest {
    @Resource
    private IProductService iProductService;

    @Test
    public void testGet() {
        System.out.println(iProductService.get(1));
    }

    @Test
    public void testAdd() {
        Product product = new Product() ;
        product.setProductName("iphone" + System.currentTimeMillis());
        System.out.println(iProductService.add(product));
    }
    @Test
    public void testList() {
        System.out.println(iProductService.list());
    }
}

创建ProductController，建立一个Rest服务类

package com.nelson.org.controller;

import com.nelson.org.entity.Product;
import com.nelson.org.service.IProductService;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-20 15:27
 * @todo
 */
@RestController
@RequestMapping("/product")
public class ProductController {
    @Resource
    private IProductService iProductService;

    @RequestMapping(value="/get/{id}")
    public Object get(@PathVariable("id") long id) {
        return this.iProductService.get(id) ;
    }
    @RequestMapping(value="/add")
    public Object add(@RequestBody Product product) {
        return this.iProductService.add(product) ;
    }
    @RequestMapping(value="/list")
    public Object list() {
        return this.iProductService.list() ;
    }
}

启动项目
浏览器访问：
调用get请求：localhost:8080/product/get/1
调用list请求：localhost:8080/product/list

2.4 建立一个子模块demo-consumer作为服务的消费者

这个模块作为服务的消费方，用于调用前面的demo-provider-product服务
pom文件如下，此模块中也引入了demo-common模块

<?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">
    <parent>
        <artifactId>demo-spring-cloud</artifactId>
        <groupId>com.nelson.org</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>demo-consumer</artifactId>


    <dependencies>
        <dependency>
            <groupId>com.nelson.org</groupId>
            <artifactId>demo-common</artifactId>
            <version>1.0.0</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-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>
</project>

为此模块添加一个yml文件，指定端口为80

创建Rest配置类，这里需要调用Rest服务，一般需要用到RestTemplate类对象

package org.nelson.com.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
/**
 * @auther 1301913120@qq.com
 * @create 2019-06-20 15:39
 * @todo
 */


@Configuration
public class RestConfig {
    @Bean
    public RestTemplate restTemplate() {
        return  new RestTemplate();
    }
}

新建一个Controller，负责使用RestTemplate去滴啊用远程的demo-provider-product服务

package com.nelson.org.controller;

import com.nelson.org.entity.Product;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import javax.annotation.Resource;
import java.util.List;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-20 15:45
 * @todo
 */
@RestController
@RequestMapping("/consumer")
public class ConsumerProductController {
    public static final String PRODUCT_GET_URL = "http://localhost:8080/product/get/";
    public static final String PRODUCT_LIST_URL="http://localhost:8080/product/list/";
    public static final String PRODUCT_ADD_URL = "http://localhost:8080/product/add/";
    @Resource
    private RestTemplate restTemplate;

    @RequestMapping("/product/get")
    public Object getProduct(long id) {
        Product product = restTemplate.getForObject(PRODUCT_GET_URL + id, Product.class);
        return  product;
    }

    @RequestMapping("/product/list")
    public  Object listProduct() {
        List<Product> list = restTemplate.getForObject(PRODUCT_LIST_URL, List.class);
        return  list;
    }

    @RequestMapping("/product/add")
    public Object addPorduct(Product product) {
        Boolean result = restTemplate.postForObject(PRODUCT_ADD_URL, product, Boolean.class);
        return  result;
    }
}

为demo-consumer编写一个启动类

package com.nelson.org;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @auther 1301913120@qq.com
 * @create 2019-06-12 20:41
 * @todo
 */
@SpringBootApplication
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }
}

启动demo-provider-product和demo-consumer
调用测试
新增：http://localhost/consumer/product/add?productName=电视机
列表查询：http://localhost/consumer/product/list
获得单个数据：http://localhost/consumer/product/get?id=1

未完待续…
(后面会加上安全模块以及服务注册中心)