传智黑马学成在线第1天讲义-项目概述 CMS接口开发五

古城微笑少年丶 2022-11-20 00:59 95阅读 0赞

**6 ****页面查询服务端开发**  
**6.1 ****创建****CMS****服务工程**  
**6.1.1 ****创建****CMS****工程结构**  
创建maven工程， CMS工程的名称为 xc\-service\-manage\-cms，父工程为xc\-framework\-parent。  
pom.xml如下：

<?xml version="1.0"encoding="UTF‐8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="
    [url=http://www.w3.org/2001/XMLSchema]http://www.w3.org/2001/XMLSchema[/url]‐instance"xsi:schemaLocation="
    [url=http://maven.apache.org/POM/4.0.0]http://maven.apache.org/POM/4.0.0[/url]
    [url=http://maven.apache.org/xsd/maven]http://maven.apache.org/xsd/maven[/url]‐4.0.0.xsd">
    <parent>
    <artifactId>xc‐framework‐
    parent</artifactId>
    <groupId>com.xuecheng</groupId>
    <version>1.0‐SNAPSHOT</version>
    <relativePath>../xc‐framework‐
    parent/pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>xc‐service‐manage‐
    cms</artifactId>
    <dependencies>
    <dependency>
    <groupId>com.xuecheng</groupId>
    <artifactId>xc‐service‐
    api</artifactId>
    <version>1.0‐
    SNAPSHOT</version>
    </dependency>
    <dependency>
    <groupId>com.xuecheng</groupId>
    <artifactId>xc
    ‐
    framework
    ‐
    model</artifactId>
    <version>1.0
    ‐
    SNAPSHOT</version>
    </dependency>
    <dependency>
    <groupId>com.xuecheng</groupId>
    <artifactId>xc
    ‐
    framework
    ‐
    utils</artifactId>
    <version>1.0
    ‐
    SNAPSHOT</version>
    </dependency>
    <dependency>
    <groupId>com.xuecheng</groupId>
    <artifactId>xc
    ‐
    framework
    ‐
    common</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
    ‐
    freemarker</artifactId>
    </dependency>
    <dependency>
    <groupId>org
    .springframework.boot</groupId>
    <artifactId>spring
    ‐
    boot
    ‐
    starter
    ‐
    data
    ‐
    mongodb</artifactId>
    </dependency>
    <dependency>
    <groupId>org
    .springframework.boot</groupId>
    <artifactId>spring
    ‐
    boot
    ‐
    starter
    ‐
    amqp</artifactId>
    </dependency>
    <dependency>
    <groupId>com.squareup
    .okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    </dependency>
    <dependency>
    <groupId>org
    .springframework.boot</groupId>
    <artifactId>spring
    ‐
    boot
    ‐
    starter
    ‐
    test</artifactId>
    </dependency>
    </dependencies>
    </project>

由于cms工程要连接mongodb所以需要在在cms服务端工程添加如下依赖：  
项目使用spring data mongodb操作mongodb数据库

<dependency>[/size][/font]
    [font=微软雅黑][size=3]<groupId>org
    .springframework.boot</groupId>
    <artifactId>spring
    ‐
    boot
    ‐
    starter
    ‐
    data
    ‐
    mongodb</artifactId>
    </dependency>

2、创建基本的包结构：  
com.xuecheng  
.manage\_cms.confifig：配置类目录，数据库配置、MQ配置等  
com.xuecheng  
.manage\_cms.dao：dao接口目录  
com.xuecheng  
.manage\_cms.service：service类目录  
com.xuecheng  
.manage\_cms.web.controller：controller类目录  
工程结构如下  
  
![8ff9dec3bc6eaa2de747c503e9f8ecfa.png][]  
3、配置文件  
在classpath下配置application.yml

server:
    port: 31001
    spring:
    application:
    name: xc‐service‐manage‐cms
    data:mongodb:
    uri: mongodb://root:123@localhost:27017
    database: xc_cms

另外从课程资料下“cms工程配置文件”中拷贝logback\-spring.xml，此文件为工程的日志配置文件。  
4、SpringBoot 启动类  
Spring Boot应用需要创建一个应用启动类，启动过程中会扫描Bean并注入spring 容器  
注意：此类创建在本工程com.xuecheng.manage\_cms包下

@SpringBootApplication
    @EntityScan(
    "
    com.xuecheng
    .framework.domain.cms
    "
    )//扫描实体类
    @ComponentScan(basePackages
    =
    {
    "
    com.xuecheng
    .api
    "
    })//扫描接口
    @ComponentScan(basePackages
    =
    {
    "
    com.xuecheng
    .manage_cms
    "
    })//扫描本项目下的所有类
    public class ManageCmsApplication {
    public static void main(String[] args) {
    SpringApplication.run(ManageCmsApplication.class,args);
    }
    }

**6.1.2 ****测试****Controller**  
使用springMVC完成接口实现开发，这里暂时使用测试数据，稍后会让controller调用service来查询数据。

package com.xuecheng
    .manage_cms.web.controller;
    import com.xuecheng
    .api.cms.CmsPageControllerApi;
    import com.xuecheng
    .framework.domain.cms.request.
    QueryPageRequest;
    import com.xuecheng
    .framework.model.response.
    QueryResponseResult;
    import com.xuecheng
    .manage_cms.service.PageService;
    import org
    .springframework.beans.factory
    .annotation.Autowired;
    import org
    .springframework.web.bind.annotation.PathVariable;
    import org
    .springframework.web.bind.annotation.RestController;
    @RestController
    public class CmsPageController implements CmsPageControllerApi {
    @Override
    @GetMapping(
    "
    /list/{page}/{size}
    "
    )
    public QueryResponseResult findList(@PathVariable(
    "
    page
    "
    ) int page,@PathVariable(
    "
    size
    "
    ) int
    size,QueryPageRequest queryPageRequest) {
    //暂时采用测试数据，测试接口是否可以正常运行
    QueryResult queryResult
    = new QueryResult();
    queryResult.setTotal(2);
    //静态数据列表
    List list
    = new ArrayList();
    CmsPage cmsPage
    = new CmsPage();
    cmsPage.setPageName(
    "
    测试页面
    "
    );
    list.add(cmsPage)
    queryResult.setList(list);
    QueryResponseResult queryResponseResult
    = new
    QueryResponseResult(CommonCode.SUCCESS,queryResult);
    return queryResponseResult;
    }
    }

使用浏览器测试  
输入：http://localhost:31001/cms/page/list/1/10 查询第1页，每页显示10条记录

**6.2 Dao**  
**6.2.1 ****分页查询测试**  
**6.2.1.1 ****定义****Dao****接口**  
本项目使用Spring Data Mongodb完成Mongodb数据库的查询，Spring Data Mongodb提供一套快捷操作mongodb的方法。  
创建Dao，继承MongoRepository，并指定实体类型和主键类型。

public interface CmsPageRepository extends MongoRepository<CmsPage,String> {}

**6.2.1.2****编写测试类**  
![a3f1ec4fd483b2ce00433dd077dd8dfd.png][]  
  
test下的包路径与main下的包路径保持一致。  
测试程序使用@SpringBootTest和@RunWith(SpringRunner.class)注解，启动测试类会从main下找springBoot启动类，加载spring容器。  
测试代码如下：

package com.xuecheng
    .manage_cms;
    import com.xuecheng
    .framework.domain.cms.CmsPage;
    import com.xuecheng
    .manage_cms.dao.CmsPageRepository;
    import org
    .
    junit.Test;
    import org
    .
    junit.runner.RunWith;
    import org
    .springframework.beans.factory
    .annotation.Autowired;
    import org
    .springframework.boot.test.context.SpringBootTest;
    import org
    .springframework.data.domain.*
    ;
    import org
    .springframework.test.context.
    junit4.SpringRunner;
    @SpringBootTest
    @RunWith(SpringRunner.class)
    public class CmsPageRepositoryTest {
    @Autowired
    CmsPageRepository cmsPageRepository;
    }

**6.2.1.3 ****分页查询测试**

//分页测试
    @Test
    public void testFindPage() {
    int page
    =
    0;//从0开始
    int size
    = 10;//每页记录数
    Pageable pageable
    = PageRequest.of(page,size);
    Page<CmsPage> all =
    cmsPageRepository
    .findAll(pageable);
    System.out.
    println(all);
    }

**6.2.2 ****基础方法测试**  
这里Dao接口继承了MongoRepository，在MongoRepository中定义了很多现成的方法，如save、delete等，通过下边的代码来测试这里父类方法。  
此小节内容请同学们自行测试。  
**6.2.3.1 ****添加**

//添加
    @Test
    public void testInsert(){
    //定义实体类
    CmsPage cmsPage
    = new CmsPage();
    cmsPage.setSiteId(
    "
    s01
    "
    );
    cmsPage.setTemplateId(
    "
    t01
    "
    );
    cmsPage.setPageName(
    "
    测试页面
    "
    );
    cmsPage.setPageCreateTime(new Date());
    List<CmsPageParam> cmsPageParams
    = new ArrayList<>();
    CmsPageParam cmsPageParam = new CmsPageParam();
    cmsPageParam.setPageParamName(
    "
    param1
    "
    );
    cmsPageParam.setPageParamValue(
    "
    value1
    "
    );
    cmsPageParams.add(cmsPageParam);
    cmsPage.setPageParams(cmsPageParams);
    cmsPageRepository
    .save(cmsPage);
    System.out.
    println(cmsPage);
    }

**6.2.3.2 ****删除**

//删除
    @Test
    public void testDelete() {
    cmsPageRepository
    .deleteById("5b17a2c511fe5e0c409e5eb3");}

**6.2.3.3 ****修改**

//修改
    @Test
    public void testUpdate() {
    Optional<CmsPage> optional =
    cmsPageRepository
    .findOne(
    "
    5b17a34211fe5e2ee8c116c9
    "
    );
    if(optional.isPresent()){
    CmsPage cmsPage
    =
    optional.
    get();
    cmsPage.setPageName(
    "
    测试页面01
    "
    );
    cmsPageRepository
    .save(cmsPage);
    }
    }

关于Optional：  
Optional是jdk1.8引入的类型，Optional是  
一  
个容器对象，它包括了我们需要的对象，使用isPresent方法判断所包  
含对象是否为空，isPresent方法返回false则表示Optional包含对象为空，否则可以使用get()取出对象进行操作。  
Optional的优点是：  
1、提醒你非空判断。  
2、将对象非空检测标准化。  
**6.2.3.4 ****自定义****Dao****方法**  
同Spring Data JPA  
一  
样Spring Data mongodb也提供自定义方法的规则，如下：  
按照fifindByXXX，fifindByXXXAndYYY、countByXXXAndYYY等规则定义方法，实现查询操作。

public interface CmsPageRepository extends MongoRepository<CmsPage,String> {
    //根据页面名称查询
    CmsPage findByPageName(String pageName);
    //根据页面名称和类型查询
    CmsPage findByPageNameAndPageType(String pageName,String pageType);
    //根据站点和页面类型查询记录数
    int countBySiteIdAndPageType(String siteId,String pageType);
    //根据站点和页面类型分页查询
    Page<CmsPage> findBySiteIdAndPageType(String siteId,String pageType, Pageable pageable);
    }

**6.3 Service**  
定义页面查询方法，根据条件查询暂时不实现：

package com.xuecheng
    .manage_cms.service;
    import com.xuecheng
    .framework.domain.cms.CmsPage;
    import com.xuecheng
    .framework.domain.cms.request.
    QueryPageRequest;
    import com.xuecheng
    .framework.model.response.CommonCode;
    import com.xuecheng
    .framework.model.response.
    QueryResponseResult;
    import com.xuecheng
    .framework.model.response.
    QueryResult;
    import com.xuecheng
    .manage_cms.dao.CmsPageRepository;
    import org
    .springframework.beans.factory
    .annotation.Autowired;
    import org
    .springframework.data.domain.Page;
    import org
    .springframework.data.domain.PageRequest;
    import org
    .springframework.data.domain.Pageable;
    import org
    .springframework.stereotype.Service;
    @Service
    public class PageService {
    @Autowired
    CmsPageRepository cmsPageRepository;
    /
    **
    *
    页面列表分页查询
    *
    @param page 当前页码
    *
    @param size 页面显示个数
    *
    @param queryPageRequest 查询条件
    *
    @return 页面列表
    *
    /
    public QueryResponseResult findList(int page,int size,QueryPageRequest queryPageRequest){
    if (queryPageRequest
    == null) {
    queryPageRequest
    = new QueryPageRequest();
    }
    if (page <
    =
    0) {
    page
    = 1;
    }
    page
    =
    page
    ‐
    1;//为了适应mongodb的接口将页码减1
    if (size <
    =
    0) {
    size
    = 20;
    }
    //分页对象
    Pageable pageable
    = new PageRequest(page, size);
    //分页查询
    Page<CmsPage> all =
    cmsPageRepository
    .findAll(pageable);
    QueryResult<CmsPage> cmsPageQueryResult
    = new QueryResult<CmsPage>();
    cmsPageQueryResult.setList(all.
    getContent());
    cmsPageQueryResult.setTotal(all.
    getTotalElements());
    //返回结果
    return new QueryResponseResult(CommonCode.SUCCESS,cmsPageQueryResult);
    }
    }

**6.4 Controller**  
使用springMVC完成接口实现开发。

package com.xuecheng
    .manage_cms.web.controller;
    import com.xuecheng
    .api.cms.CmsPageControllerApi;
    import com.xuecheng
    .framework.domain.cms.request.
    QueryPageRequest;
    import com.xuecheng
    .framework.model.response.
    QueryResponseResult;
    import com.xuecheng
    .manage_cms.service.PageService;
    import org
    .springframework.beans.factory
    .annotation.Autowired;
    import org
    .springframework.web.bind.annotation.PathVariable;
    import org
    .springframework.web.bind.annotation.RestController;
    @RestController
    public class CmsPageController implements CmsPageControllerApi {
    @Autowired
    PageService pageService;
    @Override
    @GetMapping(
    "
    /list/{page}/{size}
    "
    )
    public QueryResponseResult findList(@PathVariable(
    "
    page
    "
    ) int page, @PathVariable(
    "
    size
    "
    )
    int size, QueryPageRequest queryPageRequest) {
    return pageService.findList(page,size,queryPageRequest);
    }
    }

使用浏览器测试  
输入：http://localhost:31001/cms/page/list/1/10 查询第1页，每页显示10条记录。  
**6.6 ****接口开发规范**  
**6.6.1 Api****请求及响应规范**  
为了严格按照接口进行开发，提高效率，对请求及响应格式进行规范化。  
1、get 请求时，采用key/value格式请求，SpringMVC可采用基本类型的变量接收，也可以采用对象接收。  
2、Post请求时，可以提交form表单数据（application/x\-www\-form\-urlencoded）和Json数据（Content\-Type=application/json），文件等多部件类型（multipart/form\-data）三种数据格式，SpringMVC接收Json数据使用@RequestBody注解解析请求的json数据。  
4、响应结果统一信息为：是否成功、操作代码、提示信息及自定义数据。  
5、响应结果统一格式为json。  
**6.6.2 Api****定义约束**  
  
Api定义使用SpringMVC来完成，由于此接口后期将作为微服务远程调用使用，在定义接口时有如下限制：  
1、@PathVariable 统一指定参数名称，如：@PathVariable("id")  
2、@RequestParam统一指定参数名称，如：@RequestParam（"id"）  
  
**7 ****页面查询接口测试**  
上边的代码是基于服务端编写接口，如果前端人员等待服务端人员将接口开发完毕再去开发前端内容这样做效率是非常低下的，所以当接口定义完成，可以使用工具生成接口文档，前端人员查看接口文档即可进行前端开发，这样前端和服务人员并行开发，大大提高了生产效率。  
本章节介绍两种接口开发工具，Swagger和Postman。  
**7.1 Swagger**  
**7.1.1 Swagger****介绍**  
OpenAPI规范（OpenAPI Specifification 简称OAS）是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程，目前版本是V3.0，并且已经发布并开源在github上。  
（https://github.com/OAI/OpenAPI\-Specifification）  
Swagger是全球最大的OpenAPI规范（OAS）API开发工具框架，支持从设计和文档到测试和部署的整个API生命周期的开发。 (https://swagger.io/)  
Spring Boot 可以集成Swagger，生成Swagger接口，Spring Boot是Java领域的神器，它是Spring项目下快速构建项目的框架。  
**7.1.2 Swagger****常用注解**  
在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：  
@Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接口  
@ApiParam：单个参数描述 @ApiModel：用对象来接收参数 @ApiModelProperty：用对象接收参数时，描述对象的一个字段 @ApiResponse：HTTP响应其中1个描述 @ApiResponses：HTTP响应整体描述 @ApiIgnore：使用该注解忽略这个API @ApiError ：发生错误返回的信息 @ApiImplicitParam：一个请求参数  
@ApiImplicitParams：多个请求参数  
  
@ApiImplicitParam属性：  
  
![ae8c49e9d828c8125910535fba1ccf13.png][]  
**7.1.3 Swagger****接口定义**  
修改接口工程中页面查询接口，添加Swagger注解。

@Api(value
    =
    "
    cms页面管理接口
    "
    ,description =
    "
    cms页面管理接口，提供页面的增、删、改、查
    "
    )
    public interface CmsPageControllerApi {
    @ApiOperation(
    "
    分页查询页面列表
    "
    )
    @ApiImplicitParams({
    @ApiImplicitParam(name
    =
    "
    page
    "
    ,value
    =
    "
    页
    码
    "
    ,required
    =
    true,paramType
    =
    "
    path
    "
    ,dataType
    =
    "
    int
    "
    ),
    @ApiImplicitParam(name
    =
    "
    size
    "
    ,value
    =
    "
    每页记录
    数
    "
    ,required
    =
    true,paramType
    =
    "
    path
    "
    ,dataType
    =
    "
    int
    "
    )
    })
    public QueryResponseResult findList(int page, int size, QueryPageRequest queryPageRequest) ;
    }

在QueryPageRequest类中使用注解 ApiModelProperty 对属性注释：

@Data
    public class QueryPageRequest extends RequestData {
    //站点id
    @ApiModelProperty(
    "
    站点id
    "
    )
    private String siteId;
    //页面ID
    @ApiModelProperty(
    "
    页面ID
    "
    )
    private String pageId;
    //页面名称
    @ApiModelProperty(
    "
    页面名称
    "
    )
    private String pageName;
    //页面别名
    @ApiModelProperty(
    "
    页面别名
    "
    )
    private String pageAliase;
    //模版id
    @ApiModelProperty(
    "
    模版id
    "
    )
    private String templateId;
    }

**7.1.4 Swagger****接口测试**  
Swagger接口生成工作原理：  
1、系统启动，扫描到api工程中的Swagger2Confifiguration类  
2、在此类中指定了包路径com.xuecheng，找到在此包下及子包下标记有@RestController注解的controller类  
3、根据controller类中的Swagger注解生成接口文档。  
启动cms服务工程，查看接口文档，请求：http://localhost:31001/swagger\-ui.html  
![3d5d78c53f4aaad0355b7d0f32fff587.png][]  
点击“分页查询页面列表”，打开接口详情  
  
![0a20bf5206200cd39e70c6c1d1bd6009.png][]  
使用Swagger工具测试服务接口：  
1）在cms服务接口中打断点  
2）打开接口文档页面，输入请求参数，点击“Try it out”发起请求。  
  
![df5ba0d69b1222bb2e89e14e5c5b2f4e.png][]  
**7.5 Postman**  
  
Postman是一款功能强大的http接口测试工具，使用postman可以完成http各种请求的功能测试。  
官方地址：https://www.getpostman.com/  
1、安装Postman  
本教程使用，双击打开 Postman\-win64\-6.0.10\-Setup.exe  
新建一个Postman窗口  
  
![c1bce7048b344e56e42fab2b9f6c455d.png][]  
2、使用postman测试http接口  
![ec8a3363e13c326ecd404dce9587c4a9.png][]  
  
3、请求参数设置  
1） get请求参数设置  
  
![a50956bdec33a5b1d743770100b3c3ca.png][]  
form\-data：将表单的数据转为键值对，并且可以包括文件x\-www\-form\-urlencoded: content\-type为application/x\-www\-from\-urlencoded，将表单的数据转为键值对  
raw：请求text、json、xml、html，比如如果请求json数据则使用此格式binary：content\-type为application/octet\-stream，可用于上传文件。

推荐学习：

[20天企业开发实战品优购电商系统开发上（1-10天） ][20_1-10]

视频链接：http://yun.itheima.com/course/295.html?stt  
提取码：epxm

[8ff9dec3bc6eaa2de747c503e9f8ecfa.png]: /images/20221120/28d55376e39a4926b4b88ecd9e4ee4f6.png
[a3f1ec4fd483b2ce00433dd077dd8dfd.png]: /images/20221120/74cd07e91c3141e3aeefe44eeff92c15.png
[ae8c49e9d828c8125910535fba1ccf13.png]: /images/20221120/7a381c2725114d9ba7a7c150903d4640.png
[3d5d78c53f4aaad0355b7d0f32fff587.png]: /images/20221120/3e9fb4079516425dbbf32e78d56d00aa.png
[0a20bf5206200cd39e70c6c1d1bd6009.png]: https://img-blog.csdnimg.cn/img_convert/0a20bf5206200cd39e70c6c1d1bd6009.png
[df5ba0d69b1222bb2e89e14e5c5b2f4e.png]: https://img-blog.csdnimg.cn/img_convert/df5ba0d69b1222bb2e89e14e5c5b2f4e.png
[c1bce7048b344e56e42fab2b9f6c455d.png]: https://img-blog.csdnimg.cn/img_convert/c1bce7048b344e56e42fab2b9f6c455d.png
[ec8a3363e13c326ecd404dce9587c4a9.png]: https://img-blog.csdnimg.cn/img_convert/ec8a3363e13c326ecd404dce9587c4a9.png
[a50956bdec33a5b1d743770100b3c3ca.png]: https://img-blog.csdnimg.cn/img_convert/a50956bdec33a5b1d743770100b3c3ca.png
[20_1-10]: http://yun.itheima.com/course/295.html?stt