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

Dear 丶 2022-12-22 11:26 73阅读 0赞

**4.3 MongoDB****入门**  
**4.3.1 ****安装****MongoDB**  
CMS采用MongoDB数据库存储CMS页面信息，CMS选用Mongodb的原因如下：  
1、Mongodb是非关系型数据库，存储Json格式数据 ,数据格式灵活。  
2、相比课程管理等核心数据CMS数据不重要，且没有事务管理要求。  
参考“mongodb  
安装.md”  
安装Mongodb Server及 Studio 3T客户端软件。  
**4.3.2 MongoDB****入门**  
参考“mongodb安装及入门”文档进行学习。  
**4.4 ****导入****CMS****数据库**  
导入cms数据库：  
使用Studio 3T软件导入cms数据库  
1、创建xc\_cms数据库  
  
![39d16144e72a6be6c485a42cf78a6897.png][]  
2、导入 cms数据库  
右键数据库，点击导入数据库  
![f797ca430ef03602b192a7fb447eba03.png][]  
  
打开窗口，选择第一个 json。  
下一步，选择要导入的数据文件（json文件）  
  
![1f591df0eb6c05c30c56f81ff4db87a9.png][]  
下一步操作即可完成。  
导入成功：  
  
![00ed0c1e18aeb8486b39904d080ab6cb.png][]  
**5 ****页面查询接口定义**  
  
**5.1 ****定义模型**  
**5.1.1 ****需求分析**  
在梳理完用户需求后就要去定义前后端的接口，接口定义后前端和后端就可以依据接口去开发功能了。  
本次定义页面查询接口，本接口供前端请求查询页面列表，支持分页及自定义条件查询方式。  
具体需求如下：  
1、分页查询CmsPage 集合下的数据  
2、根据站点Id、模板Id、页面别名查询页面信息  
3、接口基于Http Get请求，响应Json数据  
**5.1.2 ****模型类介绍**  
接口的定义离不开数据模型，根据前边对需求的分析，整个页面管理模块的数据模型如下：  
![6fa57b96a08f665440b296e8fd83b5aa.png][]  
  
CmsSite：站点模型  
CmsTemplate：页面模板  
CmsPage：页面信息  
页面信息如下：

<table style="width:700px;"> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">01</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">02</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">03</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">04</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">05</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">06</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">07</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">08</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">09</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">10</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">11</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">12</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">13</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">14</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">15</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">16</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">17</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">18</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">19</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">20</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">21</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">22</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">23</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">24</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">25</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">26</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">27</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">28</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">29</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">30</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">31</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">32</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">33</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">34</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">35</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">36</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">37</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">38</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">39</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">40</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">41</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">42</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">43</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">44</span> 
    </div> </td> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>@Data</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>@ToString</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>@Document</code> 
      <code>(</code> 
      <code>collection </code> 
      <code>=</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>"cms_page"</code> 
      <code>)</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public </code> 
      <code>class</code> 
      <code>CmsPage </code> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>*</code> 
      <code>*</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>*</code> 
      <code>页面名称、别名、访问地址、类型（静态</code> 
      <code>/</code> 
      <code>动态）、页面模版、状态</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>*</code> 
      <code>/</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>站点ID</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String siteId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>页面ID</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>@Id</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>页面名称</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageName;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>别名</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageAliase;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>访问地址</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageWebPath;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>参数</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageParameter;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>物理路径</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pagePhysicalPath;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>类型（静态</code> 
      <code>/</code> 
      <code>动态）</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageType;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>页面模版</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageTemplate;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>页面静态化内容</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageHtml;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>状态</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageStatus;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>创建时间</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private Date pageCreateTime;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>模版</code> 
      <code>id</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String templateId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>参数列表，暂不用</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private List</code> 
      <code>&lt;</code> 
      <code>CmsPageParam</code> 
      <code>&gt;</code> 
      <code>pageParams;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>模版文件Id</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>private String templateFileId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>静态文件Id</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String htmlFileId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>数据Url</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String dataUrl;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

属性说明：  
1、定义  
一个页面需要指定页面所属站点  
一个站点包括多个页面，比如：学成在线的门户站点（网站）包括了多个页面。  
2、定义  
一个页面需要指定页面使用的模板  
多个页面可以使用相同的模板，比如：商品信息模板，每个商品就是  
一个页面，所有商品使用同  
一个商品信息模板  
注解说明：  
@Data、@ToString、@Document注解表示什么意思？  
@Data、@ToString：是Lombok提供的注解，下边会介绍。  
@Document：是Spring Data mongodb提供的注解，最终CMS的开发会使用Mongodb数据库。  
  
**5.2.3 Lombok**  
上边的Data注解表示什么意思呢？Data注解，ToString注解都是Lombok提供的注解。  
Lombok是一个实用的java工具，使用它可以消除java代码的臃肿，Lombok提供一系列的注解，使用这些注解可以不用定义getter/setter、equals、构造方法等，它会在编译时在字节码文件自动生成这些通用的方法，简化开发人员的工作。  
项目官方地址：https://www.projectlombok.org/  
比如上节创建的UserTest模型，@Data注解可以自动生成getter/setter方法，@ToString生成tostring方法。  
使用方法：  
1、在项目中添加Lombok的依赖  
作用：项目在编译时根据Lombok注解生成通用方法。

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">1</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">2</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">3</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">4</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">5</span> 
    </div> </td> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>&lt;</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&lt;</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
      <code>org.</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>projectlombok</code> 
      <code>&lt;</code> 
      <code>/</code> 
      <code>groupId</code> 
      <code>&gt;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&lt;</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
      <code>lombok</code> 
      <code>&lt;</code> 
      <code>/</code> 
      <code>artifactId</code> 
      <code>&gt;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>&lt;</code> 
      <code>/</code> 
      <code>dependency</code> 
      <code>&gt;</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

2、在IDEA开发工具中添加Lombok插件  
作用：使用IDEA开发时根据Lombok注解生成通用方法，不报错。  
![17c620c65c426e98e0625adb8aff82ff.png][]  
  
![3ed708e74ec9b56b1c0df6c394742e78.png][]  
**5.2****定义接口**  
**5.2.1 ****定义请求及响应类型**  
1、定义请求模型QueryPageRequest，此模型作为查询条件类型为后期扩展需求，请求类型统一继承RequestData类型

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">01</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">02</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">03</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">04</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">05</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">06</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">07</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">08</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">09</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">10</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">11</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">12</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">13</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">14</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">15</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">16</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">17</span> 
    </div> 
    <div style="margin-left:0px;"> 
     <span style="color:#afafaf;">18</span> 
    </div> </td> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0px;"> 
     <div style="margin-left:0px;"> 
      <code>package com.xuecheng</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>.framework.domain.cms.request;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>import com.xuecheng</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>.framework.model.request.RequestData;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>import lombok.Data;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>@Data</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>public </code> 
      <code>class</code> 
      <code>QueryPageRequest extends RequestData </code> 
      <code>{ </code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>站点</code> 
      <code>id</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String siteId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>页面ID</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>页面名称</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageName;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>别名</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String pageAliase;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>/</code> 
      <code>/</code> 
      <code>模版</code> 
      <code>id</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>private String templateId;</code> 
     </div> 
     <div style="margin-left:0px;"> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

2、响应结果类型，分页查询统一使用QueryResponseResult  
**5.2.2 ****定义接口**  
  
在Api接口工程专门定义接口，在Api工程单独定义接口的原因如下：  
1、接口集中管理  
2、Api工程的接口将作为各微服务远程调用使用。页面查询接口定义如下：

此接口编写后会在CMS服务工程编写Controller类实现此接口。

推荐学习：[20天企业开发实战品优购电商系统开发上（1-10天） ][20_1-10]  
提取码：epxm   全部java品优购视频资料可私信

[39d16144e72a6be6c485a42cf78a6897.png]: /images/20221120/9886e50c825f437d9b59354719c725bf.png
[f797ca430ef03602b192a7fb447eba03.png]: /images/20221120/068440725084474dabe48b167c961e8a.png
[1f591df0eb6c05c30c56f81ff4db87a9.png]: /images/20221120/9df3c89838614fa4ace1d571a056b329.png
[00ed0c1e18aeb8486b39904d080ab6cb.png]: /images/20221120/0169a035c0d84a13b941497b9edf724e.png
[6fa57b96a08f665440b296e8fd83b5aa.png]: /images/20221120/1184e22f8a2d40389c48468ebe40aaa7.png
[17c620c65c426e98e0625adb8aff82ff.png]: /images/20221120/5c2e74bff65e430e8092c81e89e73d16.png
[3ed708e74ec9b56b1c0df6c394742e78.png]: /images/20221120/6b3253a09b2f4b99a0dc87f54036022f.png
[20_1-10]: http://yun.itheima.com/course/295.html?stt