基于Spring框架搭建网站实验

你的名字 2024-04-06 10:07 56阅读 0赞

## 一、引言 ##

背景及要求：

\[综述研究背景：概述本项工作的研究或观察的理论基础，给出简明的理论或研究背景，一定要列举重要的相关文献。若可能指出存在问题：说明为什么要做这项工作；阐述研究目的：说明有别于他人的“主意”（此红色字体一条不做强行要求）。\]

现实生活中，存在着大量发送手机短信通知，发送电子邮件消息的系统需求，例如：当你登录 AWS 或阿里云账号时，可以通过手机验证实现账号登入功能。这类通知服务是可以在其他应用程序中重用的功能模块。

结合课堂上讲授的SOA风格，基于AWS SES或阿里云的邮件服务，实现一个能发送电子邮件消息的Web

Service服务，包括如下三个具体服务（开发语言不限，要求提供基于SOAP协议和REST风格的两种接口）：

sendEmail(String _url,String _payload)        //邮件地址为_url，内容为_payload 
    sendEmailBatch(String[] _url,String _payload)  //批量发送邮件 
    validateEmailAddress(String _url)            //验证是否为有效的邮件地址注：

以上三个服务，返回的值为Y或者N。例如在第一个服务中，发送成功则返回Y，发送失败则返回N。

在你实现这个服务时，可基于AWS SES或阿里云的邮件推送服务来实现你的Web Service，AWS SES 参考链接阿里云的邮件推送服务地址

validateEmailAddress方法尽量使用正则表达式完成。

编写至少两种版本客户端（例如：桌面版、Web版、Android版、IOS版），分别调用你编写的邮件推送Web Service服务，并分析Web Service集中解决远程调用、跨平台调用、跨语言调用所带来的好处及不足。

结合上述实例，从软件体系结构风格的角度分析Web Service风格的主要构件和连接件?

提示：可参考课堂上讲授的“两层C/S结构”风格基本构件：

数据库服务器：存放数据的数据库、负责数据处理的业务逻辑；

客户机应用程序：

GUI：用户界面

业务逻辑：利用客户机上的应用程序对数据进行处理；连接件：经由网络的调用-返回机制或事件机制。

客户机<->服务器：客户机向服务器发送请求，并接收返回结果。

参考Kruchten 4+1视图模型，试着给出上述系统的视图模型。

## 二、实验设计 ##

(给出你的实习内容的设计方案，可根据实际情况调整条目)

**系统需求**

技术环境需求：

服务器需要 java JDK 1.8 环境，能够运行 Spring 架构打包好的 jar 包。功能需求：完成基于 Android，EXE，HTML 的邮件发送服务，邮箱地址查阅服务客户端需要实现：

拥有交互性好的操作界面

提供输入，查询功能的接口

提供网络服务，与服务器的接口形成消息交互。

服务器需要实现：

REST 和 SOAP 的接口

每个接口对应的邮件发送和邮箱地址查询的功能。

质量需求：

无论执行成功与否，都应该给出相应的反馈，程序不会因此意外终止。

约束：

使用基于 REST 和基于 SOAP 两种风格的接口完成上述和任务。

**架构设计**

\[给出软件架构图，并给出主要构件和连接件的文字说明\]

![在这里插入图片描述][7a5245782af54929a8f181b835d5c765.png]

图 1 软件架构图

软件架构如图所示，我采用了 CS 架构来完成该程序，其思想是分别部署服务器和客户端，服务器部分是多个用户共享的信息与功能，执行后台服务，如控制共享数据库的操作等;客户机部分为用户所专有，负责执行前台功能，在出错提示、在线帮助等方面都有强大的功能，并且可以在子程序间自由切换。由于服务器以及由 Spring 架构提供了 REST 和 SOAP 的接口，不管是什么客户端，只需要依照要求访问该接口，就可以执行相应的处理任务，并得到返回值报文。显示给用户。

封装向客户端发送消息的类，提供传递参数和分别表用 REST 和 SOAP 接口的功能，客户端的每个程序都会调用该类进行发送。

其中做出主要处理的是 Server 层的服务器类，该构件的主要功能有

sendEmail 和 sendEmailBarch

提供了单独发送邮件和群发的功能，返回值为 Y 或 N，表示功能执行的状态。

validateEmail

提供了判断邮箱地址是否符合要求的功能，返回值为 Y 或 N，表示是或否。

REST 接口

提供给外部访问上述服务的接口，通过唯一标识的地址访问服务器，通过传入指定路径和特定格式的参数来访问对应地址的接口函数，在接口函数中调用上述功能，在服务器进行处理后将结果返回。

SOAP 接口

提供给外部访问上述服务的接口，通过设置 EndPoint 作为唯一标识地址，客户端封装指定格式的 xml 文件发送到该地址来访问接口函数，在接口函数中调用上述功能，在服务器处理后将结果以 XML 格式返回。

接口设计

![在这里插入图片描述][50cbc76fc4ec4596a4f55c1a694f0f13.png]

图 2 接口设计

可以看到只有两个接口，分别是 REST 风格接口和 SOAP 风格接口，服务器里的 Spring 架构分别实现 REST 风格和 SOAP 风格的接口，使得访问该服务器的客户端都可以选择调用相应接口。

### 2.1 实验过程 ###

软件实现

本系统使用了 Spring 架构进行开发。REST 和 SOAP 风格的的框架已经给出，在 maven 中设置相应框架的包就可以进行安装部署，当框架部署完毕后再实现具体的接口调用即可完成。开发时使用了迭代递增的方式，每次都只完成某一部分的构件或功能，测试无误后，再在这个基础上扩展功能或者组合功能，再进行测试，再进行后续开发，以此类推。最终一步步搭建出总体的系统。

<table> 
 <thead> 
  <tr> 
   <th>3.2 实验环境</th> 
   <th></th> 
   <th></th> 
   <th></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>处理器： i7-7700HQ</td> 
   <td></td> 
   <td></td> 
   <td>操作系统：windows10</td> 
  </tr> 
  <tr> 
   <td>开发语言：java</td> 
   <td></td> 
   <td></td> 
   <td>服务器：AWS</td> 
  </tr> 
  <tr> 
   <td>实验场景：宿舍，教室</td> 
   <td></td> 
   <td></td> 
   <td>IDE使用：IntellJ IDEA</td> 
  </tr> 
 </tbody> 
</table>

![在这里插入图片描述][c41e42d3bbac4bfca424ffba3e18e069.png]

实验步骤

① 安装配置 Spring 环境

第一步首先是安装配置环境，首先我下载了IntellJ IDEA，在新建项目的时候选择 Spring Initializr，此时接下来的项目就会从 Spring 的官网下载框架包，我们就可以在该框架下部署 REST 风格和 SOAP 风格的服务了。

REST风格和SOAP风格的选择也在新建项目的时候完成，选择如下图所示的两个选

![在这里插入图片描述][44e58d32ec7a45768c245f8537ffc237.png]

项，就会在生成项目的时候自动配置这两种 图 3 选择 Spring 框架风格。

![在这里插入图片描述][635b0609178c49a08dc5cd75875fce30.png]

图 4 选择 REST 和 SOAP 风格 等项目建立起来后，就可以使用maven 配置阿里云的依赖包，方法是把dependence 部署在 pom.xml 里，如右图所示，等待下载完成后，就可以使用邮件发送的函数了。

当环境配置完毕后进行实验，使用官网教程提供的教程\[1\]发送邮件。在发送邮件之前首先需要将邮件服务和自己的域名绑定，在这里参考了博客教程\[2\]，首先购买了一个自己的域名，然后解析该域名，与阿里云邮箱服务的要求同步，然后就可以使用阿里云邮箱服务了。

图 5 maven 配置阿里云的依赖包

② 测试使用 REST 风格接口

REST 是一种软件架构风格，或者说是一种规范，其强调 HTTP 应当以资源为中心，并且规范了 URI 的风格；规范了 HTTP 请求动作（GET/PUT/POST/DELETE/HEAD/OPTIONS）的使用，具有对应的语义。

参考搭建 REST 风格的教程\[3\]我在项目中设置了 REST 风格的接口，其本质是用

@SpringBootApplication 标记服务器运行的转函数；用@RestController 标记 REST 风格接口；用

@RequestMapping 来标识 URL 中的资源访问，根据输入不同的资源来调用不同的函数；用

@RequestParam 标记传入的参数，依此提高函数处理的功能。在有了以上的知识储备后就可以进行

REST 风格的基本测试了。

首先设置传入参数为 url，title，payload，分别代表邮箱地址，标题，邮件正文。如下图所示：

![在这里插入图片描述][11835e22a5c74a4eab29b33022c7841d.png]

图 6 REST 风格参数设置

![在这里插入图片描述][d6f2e31f36764ac9be4aa6272a9e43ec.png]

![在这里插入图片描述][81142375ed2644bfba02386c09e5ed89.png]

邮

图 7 浏览器测试 Rest 风格

测试使用 SOAP 风格接口

SOAP 是简单对象访问协议，是一种轻量的、简单的、基于 xml 的远程访问协议。可以与现有的多种传输层或应用层协议结合使用，如 TCP、HTTP、SMTP 等。SOAP 广泛使用的是基于 HTTP 和 xml 协议的实现（SOAP=RPC+HTTP+XML），也就是大家常提的 Web Service 使用的通信协议。

一个 SOAP 方法可以简单地看作遵循 SOAP 编码规则的 HTTP 请求和响应。

SOAP 风格的接口实现比 REST 复杂一些，参考了 CSDN 的教程\[4\]搭建了基本的 SOAP 框架。

SOAP 接口的部署分为如下步骤：

建立控制 xml 格式的 xsd 文件，在其中设置请求报文和回复报文都需要哪些参数，不符合要求的报文会被服务器拒绝。

建立 SOAP 的@Configuration，用来标识访 SOAP 接口的资源路径。

建立 EndPoint，是主要的服务器处理模块，用户发送的 XML 会在这里被接收，通过调用 xsd 中定义的函数调用该 request 报文中所携带的邮件地址等，然后调用发送邮件的服务，将结果再打包成 XML 文件作为 response 返回给客户端。

编写客户端

首先封装好发送邮件的类，提供接收 url，title，payload 的函数接口，当客户端获取到他们的值后调用该接口传入字符串，然后再调用封装好的发送给 soap 和发送给 rest 的函数，就可以实现邮件发送的功能了。该封装类可以在所有客户端中调用。

编写桌面端应用

桌面端应用即用 java 写的界面程序，提供邮件发送服务。界面如下图所示

![在这里插入图片描述][5af2942f5fab479d9804ccbf6bbec301.png]

图 8 桌面版邮件发送

其中每个按钮对应的功能如字面所示，分别调用的是 Rest 风格发送，Soap 风格发送，以及测试邮箱地址的格式正确性，请求会通过 HTTP 协议发送到服务器。

编写安卓端应用

安卓端的界面如下图所示：

![在这里插入图片描述][54ce337e5a0c430a8f9292d57059c0e3.png]

图 9 安卓端邮件发送

和桌面端的应用一样，都分为三个功能按钮和输入界面，不过安卓端可以群发。

HTML 页面应用

HTML 页面的展示已经在最上面展示过，这里不多赘述。

上传服务器

上传打包 jar 包到服务器。首先要在服务器端安装 java 环境\[5\]，然后将在本地打包的 jar 文件上传到服务器运行，然后运行部署在本地的客户端远程调用，可以看到接收和相应的结果，如下图所示。

图 10 最终结果

### 2.2 实验评价 ###

实验结果

实验结果在上面进行了给出，我认为较为完整地实现了REST和SOAP风格接口调用的功能。

并且实现了桌面，安卓，web三种终端的客户端部署。同时也封装了功能和消息的传递，减少了构件之间的耦合程度，通过数据的传输串联该C/S架构。

结果分析

![在这里插入图片描述][8dd9ed76c667460cbec5dfa66fb4add1.png]

本次实习从结果看我认为很好地实现了 REST 和 SOAP 接口的功能。在这里我采用了 C/S 的结构和 Spring 的框架。Spring 框架为开发提供了一系列的解决方案，比如利用控制反转的核心特性，并通过依赖注入实现控制反转来实现管理对象生命周期容器化，利用面向切面编程进行声明式的事务管理，整合多种持久化技术管理数据访问，提供大量优秀的 Web 框架方便开发等等。因此很轻松就能够部署上述风格。

[7a5245782af54929a8f181b835d5c765.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/b7b8013b9af2402e8840028296fdc2be.png
[50cbc76fc4ec4596a4f55c1a694f0f13.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/60c7d8dad8104a989a0af696e401caad.png
[c41e42d3bbac4bfca424ffba3e18e069.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/778c4fe07f14483d8095219dc46b1804.png
[44e58d32ec7a45768c245f8537ffc237.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/484b445c96f04b268f02c295c9252735.png
[635b0609178c49a08dc5cd75875fce30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/f326329f450343e7a3f6f929f9cdcaaa.png
[11835e22a5c74a4eab29b33022c7841d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/bb05c152c49e4deca2018fd411268515.png
[d6f2e31f36764ac9be4aa6272a9e43ec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/8bfba64c090b470e85d88299542b3984.png
[81142375ed2644bfba02386c09e5ed89.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/80e95d33dace4c3c969cef4789ba24f4.png
[5af2942f5fab479d9804ccbf6bbec301.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/310c5abae74c47688fc3c071fe7e10ab.png
[54ce337e5a0c430a8f9292d57059c0e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/c076b86e76f1416980d1c0556feac52c.png
[8dd9ed76c667460cbec5dfa66fb4add1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/d76561e6ac8644df9834a75137dfa114.png