SpringCloud应用骨架开发

Posted 2022-11-09 最老程序员闫涛

我们每做一个新项目，通常都是从另一个项目把代码拷贝过来，然后在其上做开发。但是这种模式的一个比较大的问题就是会有很多上个项目的遗留代码。因此，开发一个公共的应用骨架系统，在开始其他新项目时，从这个骨架系统开始开发，是一个很好的选择。
我们首先需要创建一个SpringBoot工程，我们可以使用：
https://start.spring.io/
如下所所：

上图中比较关键的是从页面右侧“Add Dependencies”按钮弹出的列表中选择“Spring Web”。网站上的工具会生成一个基本的SpringBoot工程，并自动将zip文件下载到本地。
将该文件解压，以idea community版本打开（也可以使用商业版，但是该版本是收费版，出于尊重知识产权的原因，使用免费的社区版）。
我们首先将系统自带的src/main/resources下面的application.properties文件删除，添加application.yaml文件，添加如下内容：

server:
  port: $port:2208
spring:
  application:
    name: first-service
logging:
  pattern:
    console: "%dHH:mm:ss.SSS %-5level %logger36 - %msg%n"
    file: "%dHH:mm:ss.SSS [%thread] %-5level %logger36 - %msg%n"
  level:
    org.springframework.web: DEBUG
  file: app.log

下面我们以Person对象的增、删、改、查操作为例，创建一个REST风格的API。
我们首先在repository包中创建Person对象：

public class Person 
    private Long personId;
    private String firstName;
    private String lastName;
    private int age;
// getter and setters
//......

接下来我们来创建REST服务端，在controller包中创建DemoController类：

@RestController
@RequestMapping("/person")
public class DemoController 
    private List<Person> persons = new ArrayList<>();

    @GetMapping
    public List<Person> findAll() 
        return persons;
    

    @GetMapping("/personId")
    public Person findById(@PathVariable("personId") Long personId,
                           HttpServletRequest request) 
        String mode = request.getParameter("mode");
        System.out.println("mode=" + mode + "!");
        return persons.stream().filter(item -> item.getPersonId().equals(personId)).findFirst().get();
    

    @PostMapping
    public Person add(@RequestBody Person p) 
        p.setPersonId((long)(persons.size()+1));
        persons.add(p);
        return p;
    

    @DeleteMapping("/personId")
    public void delete(@PathVariable("personId") Long personId) 
        List<Person> ps = persons.stream().filter(item -> item.getPersonId().
                equals(personId)).collect(Collectors.toList());
        persons.removeAll(ps);
    

    @PutMapping
    public void update(@RequestBody Person p) 
        Optional<Person> person = persons.stream().filter(item -> item.getPersonId().
                equals(p.getPersonId())).findFirst();
        person.ifPresent(po->persons.set(persons.indexOf(po), p));
    

由于用到了Jdk8以后的一些特性，这里稍做一些解释：

• 第1行：代表其是一个REST风格服务的类；
• 第2行：规定所有/person开头的请求，都由本类来进行处理；
• 第4行：使用泛型技术定义Person列表对象属性；
• 第6~9行：定义http://server/person请求，返回Json格式Person列表；
• 第11行：定义http://server/person/101?mode=2形式的请求，首先定义路径中包含的参数101为personId，分别在GetMapping和函数参数中用@RequestParam来定义，其次请求中的queryString使用函数形参中的第二个参数HttpServletRequest来获取；
• 第14、15行：获取QueryString中的mode参数；
• 第16行：在过去，我们如要想对List对象进行查找，需要自己遍历List对象，在Jdk8之后，提供了Stream API，可以帮助我们更加高效的进行查找。首先创建stream，这里其实还可以指定是否使用.parellel()并行技术来利用CPU的多核特性。然后在filter中定义查询条件，该查询条件是一个Lambda表达式，也是Jdk8之后引入的新特性，就是对列表中的每个元素item，首先获取personId属性，然后与personId参数进行比较，取相等的记录，由于相等的记录可能存在多条，我们用findFirst来取第一条，其返回结果为Optional类型，Optional同样是Jdk8之后引入的新特性，专门用于避免空指针异常。我们这里，我们非常确信其一定包括Person对象，所以通过.get函数获取出Person对象，并返回；
• 第19行：在REST风格中，POST请求用于添加新对象；
• 第20行：在缺省情况下，POST请求的内容通过application/json传递，即客户端需要将内容转换为Json格式，放入POST的请求体中，SpringBoot会自动将请求体的Json内容转化为@RequestBody指定的值对象；
• 第26行：在REST风格中，DELETE请求用于删除对象，即当用户发送的请求为DELETE /person/101 HTTP/1.0时，代表删除personId=101的对象；
• 第27行：定义delete函数，获取请求路径上的personId参数；
• 第28、29行：求出符合查询条件的Person对象列表，同样是先用成stream，在filter中定义查询条件，最后通过collect函数将查询结果转换为列表；
• 第30行：从persons列表中删除符合条件记录；
• 第33行：在REST风格中，用PUT请求来进行对象更新；
• 第34行：通过请求体中的Json字符串，由SpringBoot自动创建Person值对象；
• 第35、36行：查询出符合条件的记录，类型为Optional，在这里我们虽然可以使用if (ps.ifPresent()) …，但是这和过去null的处理方式没有什么区别，我们采用更Jdk8的形式，在ifPresent函数中提供了Lambda表达式，这义了对象更新逻辑；

我们下面需要对REST服务进行测试，我们可以通过PostMan来进行测试，但是在这里，我们将采用Swagger来进行测试。这样做主要好处是可以同时生成REST服务的文档。
我们首先在项目根目录下的pom.xml中添加如下内容：

		<!-- 开始：添加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>
		<!-- 结束：添加Swagger支持 -->
		<!-- 开始：读取maven pox.xml文件 -->
		<dependency>
			<groupId>org.apache.maven</groupId>
			<artifactId>maven-model</artifactId>
			<version>3.0</version>
		</dependency>
		<!-- 结束：读取maven pox.xml文件 -->

同时给应用类StpApplication添加如下标注：

@EnableSwagger2
@SpringBootApplication
public class StpApplication 
	......

	@Bean
	public Docket api() throws IOException, XmlPullParserException 
		MavenXpp3Reader reader = new MavenXpp3Reader();
		Model model = reader.read(new FileReader("pom.xml"));
		ApiInfoBuilder builder = new ApiInfoBuilder()
				.title("智慧交通平台")
				.description("智慧交通平台API接口文档")
				.version(model.getVersion())
				.contact(new Contact("最老程序员", "www.abc.com", "ua@"));
		return new Docket(DocumentationType.SWAGGER_2).select().
				apis(RequestHandlerSelectors.basePackage("com.zhuanjingkj.stp.demo.controller"))
						.paths(PathSelectors.any()).build()
						.apiInfo(builder.build());
	

就是添加@EnableSwagger2标注信息。在浏览器中输入如下地址：

http://localhost:2208/swagger-ui.html

会显示如下图所示页面：

我们可以点击进入对应的接口，可以看到接口的调用方法，同时可以填写真实的数据，对接口进行测试。