软件开发项目文档

软件项目开发文档概述—小微邮
一、项目名称：新浪微博发送电子邮件
二、编写目的：项目开发的主要目的是实现在新浪微博上接收信息和发送电子邮件。

三、项目分工：
xxx负责接收、发送微博信息代码及项目文档修改;
xxx负责项目窗体设计代码;
xxx负责项目文档的编写排版。

四、软件系统概述
通过新浪用户也发送信息给用户（A），用户（A）接收并回复信息，新浪好友只需知道用户的（A）的账号（A）的账户名，采用@用户A名***类似格式就可以发送信息给A，A通过接收好友的信息后，可回复给好友相应信息，本项目程序均采用Java语言编写的桌面版应用程序。

五、软件功能结构和项目脑图
程序表：
程序主要的类：GetToken类获得新浪微博信息、sendMail0类发送电子邮件、showFrame 类显示对话框。

项目脑图：
六、软件开发进度和甘特网
进度：
小微邮软件的基本功能已经实现，可以运行基本的功能：接收微博信息、发送电子邮件、显示对话框。

状态：
软件处于优化不足中。

甘特网：
八、最小原型化构想
新浪微博信息获取模型：
“小微邮”软件利用微博包中的getMention（）函数返回最新提到登录用户的微博消息（即包含@username的微博消息），将微博中提及Z_legend用户的消息获取，并形成链，逐个输出发给Z_legend用户的消息并且通过TimerTask类创建对象，得到一个线程的任务单，任务. schedule()，加上刷新时间T，实现每隔T进行一次检测微博上是否有新的消息发送给Z_legend用户，在程序中为了不使每次刷新时，总是显示以前的消息和消息中的一些不必要的内容，进行了过滤消息。

实现接收一个可行及比较直观的消息框。

邮件发送模型：
“小微邮”软件利用STMP（简易邮件发送协议）发送邮件，通过设定用户自己的信息（程序中利用xlegendx@）邮箱，进行任何用户的邮件的发送（可以是微博信息发送者的微博，也可以是用户任意输入的用户邮箱地址）。

实现了简易的邮件的传输。

九、其他
编写过程中的问题：
1、除了系统的包外，外界包（开发平台对应的包）的概念。

2、导入外界包的问题。

（如：weibo4j的所有包，发送邮件的两个必备包：activation.jar/mail.jar等）
3、如何使用外界包的问题。

（包中的函数使用、异常处理等）
4、异常处理
5、不同邮箱收、发邮件服务器的地址问题。

（如：
QQ邮箱对应的pop3（发信）和smtp（收信服务器地址为：pop3：；smtp：
新浪免费邮箱发信(smtp)服务器的地址为：
新浪免费邮箱收信(pop3)服务器的地址为：）
6、收、发邮件的协议问题。

需要改进的地方：
1、接收微博信息的代码只能实现简单的信息接收，过滤信息不是很好。

2、发送邮件只能发送文本信息，不能发送附件、图片、音乐等其他信息。

3、登录和对话界面比较简洁、不是很美观。

用例文档----软件使用者接收微博信息
用例名称：软件使用者接收微博信息
用例概述：新浪微博软件运行后，接收微博信息的用户A一直监听，并且点击接收(receiveMSG键)微博信息后，显示出微博信息中提及@A用户的信息，显示最新的信息。

范围：新浪注册用户
主要参与者：软件使用者A
次要参与者：提及A的用户B
涉众及其关注点：
——软件注册用户A：在点击接收自己的微博信息后，可以通过软件以邮件的形式发送信息给提及自己的新浪微博用户。

——提及A的用户B（微博游民）：通过提及@A 用户然后可以在指定的邮箱中接收到A发来的邮件。

实现通信。

前置条件：网络连接正常并且可以登录新浪微博官网；
后置条件：通信正常结束。

基本事件流：
以下过程均在网络连接下进行：
1、A用户启动小微邮软件；
2、小微邮正常运行；
3、A用户在小微邮的软件界面上点击receiveMSG按钮；
4、小微邮显示提及A用户的新浪微博信息；
5、软件使用者读取新浪微博信息；
6、退出小微邮；
异常事件流(下面是部分扩展事件流)：
1a、启动小微邮失败；
3a、小微邮上显示不了提及A用户的信息；
3b、小微邮运行出错；
3c、微博信息不能识别，是一些乱码
6a、退出处于长时间等待（网络异常），退出失败；
相应的用例图如下：
软件使用者
小微邮接发信息--小微邮接发信息总用例文档
用例名称：小微邮接发信息
用例概述：新浪微博软件（小微邮）运行后，接收微博信息的用户A一直监听，并且点击接收微博信息后，显示出微博信息中提及@A用户的信息，显示最新的信息(receiveMSG键)，用户A在看完提及自己的信息后，提取微博信息中想要返回信息的用户的邮箱地址，输入在软件邮箱的位置，然后再输入相应的返回给别人的信息，点击发送邮件（SendMail），邮件在发送成功后显示邮件发送成功的显示。

范围：新浪注册用户
主要参与者：软件注册用户A
次要参与者：提及A的用户B
涉众及其关注点：
——软件注册用户A：在点击接收自己的微博信息后，可以通过软件以邮件的形式发送信息给提及自己的新浪微博用户。

——提及A的用户B（微博游民）：通过提及@A 用户然后可以在指定的邮箱中接收到A发来的邮件。

实现通信。

前置条件：网络连接正常并且可以登录新浪微博官网；
后置条件：通信正常结束。

基本事件流：
以下过程均在网络连接下进行：
7、微博游民在自己的微博上采用提及方式提及A用户，并且书写相关的信息；
8、A用户启动小微邮软件；
9、小微邮正常运行；
10、A用户在小微邮的软件界面上点击receiveMSG按钮；
11、小微邮显示提及A用户的新浪微博信息；
12、A用户查阅微博信息，选取需要返回信息的邮箱用户；
13、提取邮箱用户的邮箱地址；
14、将邮箱的地址输入到指定的输入框；
15、输入相应的返回信息；
16、点击SendMail按钮，实现邮件发送；
17、邮件发送成功提示；
18、退出小微邮；
异常事件流(下面是部分扩展事件流)：
1a、电脑用户的网络异常（网速很慢），不能登邮箱网站；
1b、邮箱网站的网页出现乱码；
3a、小微邮上显示不了提及A用户的信息；
3b、小微邮运行出错；
3c、微博信息不能识别，是一些乱码
9a、网络异常邮件发送失败；
9b、发送的邮件是一些乱码；
11a、退出处于长时间等待（网络异常），退出失败；
相应的用例图如下：
微博游民B
分析类文档---软件使用者接收微博信息
用例名称：软件使用者接收微博信息
用例概述：新浪微博软件运行后，接收微博信息的用户A一直监听，并且点击接收(receiveMSG键)微博信息后，显示出微博信息中提及@A用户的信息，显示最新的信息。

边界类
类名：显示微博信息接口
概述：正常运行软件后，用户登录软件界面，在界面上点击receiveMSG按钮，微博上提及用户的信息就可以显示出来了。

类名：软件使用者
概述：软件使用者通过电脑，双击并打开软件后可以进行，软件与人的交互，实现接收微博信息。

类名：显示提示的信息
概述：提示性信息在该区域显示，当接收到相关信息后，将显示接收成功，当接收过程中接收失败后就显示接收失败相关提示信息。

控制类
类名：接收微博的信息流
概述：
1、点击正常运行小微邮软件；
2、在新浪微博的API中调用了CONSUMER_KEY、 CONSUMER_SECRET、setProperty、
setToken、getMentions等方法并在点击receiveMSG按键后，获得当前的微博信息；
3、显示微博信息；
4、用户获取微博信息；并且微博信息在程序设计中，含有每隔10ms后的刷新功能。

5、关闭软件。

实体类
类名：用户账号
概述：账号用户可以使用的功能是：运行软件、点击接受微博信息键、关闭软件。

用户通过使用小微邮进入软件使用平台，并接收按钮接收一些新浪微博游民发送给用户的信息，并读取、分析信息的内容。

类名：微博信息
概述：微博信息是微博游民通过以@xxx abc yyy@的类型的信息，游民可以通过
该形式的格式发送给xxx相关的信息，进行信息交流。