服务端开发总结

服务端开发总结

1. 配置虚拟主机

在nginx中配置虚拟主机

  server{
  listen 80;
  server_name www.xuechengedu.com;
  ssi on;
  ssi_silent_errors on;
  location / {
  alias F:/teach/xcEdu/xcEduUI/xc‐ui‐pc‐static‐portal/;
  index index.html;
  }
  }

配置host文件 ： 开发环境使用的是Windows10 修改C:\Windows\System32\drivers\etc\hosts文件

127.0.0.1 www.xuechengedu.com 这样我们就可以通过本地来进行域名解析。网址www.xuechengedu.com经过本地解析指向的是localhost

1.2 SSI服务端包含技术

1.2.1 SSI是什么

SSI 即是指服务端嵌入 server side include 是一种类似于ASP的基于服务器的网页制作技术,大多数的服务器支持SSI命令。
原理是： 将内容发送到浏览器之前否， 可以使用服务器包含技术SSI指令将文本、图形、或者应用程序信息包含到网页中。
例如可以使用SSI包含时间戳、版本声明、或者供客户填写返回单的表单，对于在多个文件中重复出现的文本或者是图形，使用包含文件时一种简洁的方法。将内容存入一个包含文件即可，而不必将内容输入所有文件。通过一个简单的语句既可以调用包含文件，此语句指示web服务器将内容插入式适当的网页， 而且使用包含文件时，对内容的所有更改只需要在一个地方就能完成。

ssi包含类似于jsp页面中的incluce指令，ssi是在web服务端将include指定 的页面包含在网页中，渲染html网页响
应给客户端 。nginx、apache等多数web容器都支持SSI指令。

SSI指令如下：

<!‐‐#include virtual="/../....html"‐‐>

在一个门户网站的首页中，我们可以将首页进行拆分

• index.html：首页主体内容
• include/header.html：头部区域
• include/index_banner.html：轮播图
• include/index_category.html：左侧列表导航
• include/footer.html：页尾

使用SSI 我们就可以在服务器端把以上的小页面拼装成一个大页面就行展示。
我们需要在nginx的配置文件中进行配置

然后我们需要在nginx虚拟主机中开通SSI

    server{
    listen 80;
    server_name www.xuechengedu.com;
    ssi on;
    ssi_silent_errors on;
    ......

ssi的配置参数如下： ssi on： 开启ssi支持 ssi_silent_errors on：默认为off，设置为on则在处理SSI文件出错时不
输出错误信息 ssi_types：默认为 ssi_types text/html，如果需要支持shtml（服务器执行脚本，类似于jsp）则需
要设置为ssi_types text/shtml

@Data注解使用的好处

@Data注解是lombok.jar包下的注解，该注解通常用在实体bean上，不需要写出set和get方法，但是具备实体bean所具备的方法，简化编程提高变成速度。注意：项目中一定要引入lombok.jar!!

代码简洁许多，看上去不会太复杂。不过这里需要在IDE中配置好lombok，由此看来，一些工具的使用可以大大增加业务逻辑的清晰度。

---

在项目中，所有微服务中的接口的定义都是在service api接口中进行定义的。这样接口进行统一的定义， 可以使各个微服务之间方便的调用

所有的接口都是在service api下进行的

接口开发规范

Api请求及响应规范

为了严格按照接口进行开发，提高效率，对请求及响应格式进行规范化。
1、get 请求时，采用key/value格式请求，SpringMVC可采用基本类型的变量接收，也可以采用对象接收。
2、Post请求时，可以提交form表单数据（application/x-www-form-urlencoded）和Json数据（ContentType=application/json），文件等多部件类型（multipart/form-data）三种数据格式，SpringMVC接收Json数据 使用@RequestBody注解解析请求的json数据。 4、响应结果统一信息为：是否成功、操作代码、提示信息及自定义数据。
5、响应结果统一格式为json。

API定义约束

Api定义使用SpringMVC来完成，由于此接口后期将作为微服务远程调用使用，在定义接口时有如下限制：
1、@PathVariable 统一指定参数名称，如：@PathVariable(“id”)
2、@RequestParam统一指定参数名称，如： @RequestParam（“id”）

页面查询接口测试

我们项目中的代码是基于服务端编写接口，如果前端人员等待服务器将接口开发完毕再去开发前端内容这样做的效率是非常低下的，所以当接口定义完成，可以使用工具生成接口文档，前端人员查看接口文档即可进行前端开发，这样可以实现前端和后端开发的分离，大大的提高了开发效率。

介绍两种接口开发工具，Swagger 和Postman

1.Swagger介绍

OpenAPI规范是Linux基金会的一个项目，试图通过定义一种描述API和API定义的语言，来规范RESTful服务开发过程，

Swagger是全球最大的OpenAPI规范（OAS）API开发工具框架，支持从设计到文档到测试部署的整个API生命周期的开发。

Spring Boot可以集成Swagger，生成Swagger接口，Spring Boot是Java领域的神器，它是spring项目下快速构建项目的框架。

Swagger常用注解

在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：

@Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接口   
@ApiParam：单个参数描述 @ApiModel：用对象来接收参数 @ApiModelProperty：用对象接收参数时，描述对 象的一个字段 @ApiResponse：HTTP响应其中1个描述 @ApiResponses：HTTP响应整体描述

@ApiIgnore：使用 该注解忽略这个API @ApiError ：发生错误返回的信息   @ApiImplicitParam：一个请求参数 @ApiImplicitParams：多个请求参数

@ApiImplicitParam属性：

属性	取值	作用
paramType		查询参数类型
path	以地址的形式提交数据
query	直接跟参数完成自动映射赋值
body	以流的形式提交，仅支持POST
header	参数在request headers里边提交
form	以form表单的形式提交，仅支持POST
dataType		参数的数据类型 只作为标志说明，并没有实际验证
Long
String
name		接收参数名
value		接收参数的意义描述
required		参数是否是必填的
true	必填
false	非必填
defaultValue		默认值

@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);
}

Postman接口测试工具

Postman是一款强大的http接口测试工具，使用postman可以完成http各种请求的功能测试
官网地址：www.getpostman.com