Violet音樂社區設計文檔

時間 2020-06-19

標籤 violet 音樂社區設計文檔简体版

原文原文鏈接

Violet音樂社區設計文檔

Violet音樂社區設計文檔

需求分析文檔：http://www.javashuo.com/article/p-xlnrscxf-nt.htmlhtml

1、引言

1.1 編寫目的

此文檔爲「Violet」音樂社區開發團隊的指導文檔。開發人員閱讀此文檔有助於團隊間合做，同時提升軟件質量。開發者應仔細閱讀此文檔，根據文檔需求來進行開發，達到預期功能與效果。數據庫

1.2 開發背景

音樂是一門藝術，是由有組織的樂音來表達人們情感、反映人類現實生活情感的藝術。現代科技的發展使得人們能夠利用網絡隨時隨地的享受音樂，然而在當今互聯網卻不多有一個以音樂爲媒介的社交平臺。本開發團隊想以「音樂+社交」的形式，開發一款集聽歌、交友和討論爲一體的網上社區——「Violet」音樂社區。Violet多指紫羅蘭，也可形容羞怯的人，本團隊旨在經過此平臺加強人們對音樂的交流，同時拉近人與人之間的距離。網絡

2、用例圖設計

2.1遊客實例設計

搜索歌曲： 遊客在首頁搜索欄輸入歌曲名稱，網頁顯示歌曲中包含遊客輸入的搜索信息的歌曲。post
搜索相應歌手的歌曲： 遊客在首頁搜索欄輸入歌手名稱，網頁返回該歌手下對應的歌曲。網站
瀏覽評價： 遊客在點擊具體某一首歌以後能夠在網頁下方瀏覽該歌曲的相應的評論。設計

2.2 管理員實例設計

添加歌曲到曲庫：添加歌曲（包括：歌曲名稱，歌手，歌曲圖片或歌手圖片）到曲庫中。3d
下架歌曲：應一些版權方要求或歌詞中含有一些不良信息或敏感信息而從曲庫中下架歌曲。htm
限制用戶評價歌曲：當某用戶發佈的評價被其餘用戶舉報（使用不文明詞彙，發佈不良信息或敏感信息，發佈反動言論）且覈實後，封禁相應用戶在一段時間內沒法評價全部歌曲，時間長短視情節嚴重改變。blog
限制用戶發佈動態：當某用戶發佈的動態被其餘用戶舉報（使用不文明詞彙，發佈不良信息或敏感信息，發佈反動言論）且覈實後，封禁相應用戶在一段時間內沒法發佈動態，時間長短視情節嚴重改變。圖片
限制用戶建立圈子：當某用戶建立的圈子被其餘用戶舉報（圈子內討論不正常信息，組織非法活動，組織違反道德底線的活動）且覈實後，封禁相應用戶在一段時間內沒法建立圈子，時間長短視情節嚴重改變。
解散圈子：當某用戶建立的圈子被其餘用戶舉報（圈子內討論不正常信息，組織非法活動，組織違反道德底線的活動）且覈實後，管理員能夠解散該圈子。
刪除帖子：當某用戶發佈的帖子被其餘用戶舉報（帖子內發佈不正常信息，組織非法活動，組織違反道德底線的活動）且覈實後，管理員能夠解散該帖子。
刪除用戶動態：當某用戶發佈的動態被其餘用戶舉報（使用不文明詞彙，發佈不良信息或敏感信息，發佈反動言論）且覈實後，管理員能夠刪除該動態。

2.3 普通用戶實例設計

修改我的信息：用戶能夠在我的主頁上修改我的信息（包括我的暱稱，密碼，頭像，我的介紹）。
搜索歌曲：用戶在首頁搜索欄輸入歌曲名稱，網頁顯示歌曲中包含用戶輸入的搜索信息的歌曲。
搜索相應歌手的歌曲：用戶在首頁搜索欄輸入歌手名稱，網頁返回該歌手下對應的歌曲。
建立歌單：用戶能夠本身建立歌單。
把歌曲加入歌單：用戶能夠把本身喜歡的歌曲加入到本身建立的某個歌單中。
移除歌曲：用戶能夠憑藉本身喜愛把本身某個歌單中的某首歌曲移出歌單。
刪除歌單：用戶能夠憑藉本身喜愛刪除本身建立的某個歌單。
用戶關注：用戶在曲庫的評價頁面上，經過瀏覽其餘用戶的評論尋找志同道合的人進行關注。
取消用戶關注：用戶能夠在我關注的人頁面或者被關注的人的主頁進行取消關注用戶功能。
建立動態：用戶能夠在我的主頁上發佈動態（可添加圖片，動態只能被你本身和關注你的人看見）。
瀏覽動態：用戶能夠進入其餘用戶動態頁面，瀏覽其餘用戶的動態（只有關注當前用戶才能瀏覽該用戶動態，不然只能查看他的我的介紹信息）。
建立圈子：用戶能夠建立一個小組形式的圈子羣，而且邀請關注的人加入該圈子。
發佈帖子：用戶能夠在本身加入的圈子中發佈帖子，可供別的用戶評論。
邀請用戶加入圈子：能夠邀請關注的人加入圈子（須要關注的人贊成是否加入該圈子）
刪除評論（帖子，歌曲，動態）：用戶能夠憑藉本身喜愛刪除發佈的帖子評論，歌曲評論，動態評論。
添加評論（帖子，歌曲，動態）：用戶能夠在本身的發佈的帖子，動態；別人的帖子動態下面添加評論，亦或是在別人的評論下面追加評論，也能夠在歌曲下面述說本身的我的感想。
註冊帳號：遊客能夠在頁面上註冊帳號變成用戶從而進行具有一些用戶的權限。

3、類圖設計

3.1 歌手類

屬性	含義
singer_id	歌手id
singer_name	歌手姓名
singer_img	歌手圖片
play_times	播放次數
thumbs_up_num	點贊數
info	歌手介紹

方法：

Load_singer：用戶或遊客在進入網站時調用此方法加載歌手
Add_singer：管理員經過調用此方法向數據庫中添加歌手。
Delete_singer：管理員經過調用此方法向數據庫中刪除歌手。
Search_singer：遊客和用戶經過調用此方法來搜索用戶
Modify_singer：管理員經過調用此方法來修改用戶各項信息。

3.2 歌曲類

屬性	含義
song_id	歌曲id
song_name	歌曲名字
song_img	歌曲圖片
play_times	播放次數
thumbs_up_num	點贊數

方法：

Search_song:遊客和用戶調用此方法來搜索歌曲。
Search_song_by_singer:遊客和用戶調用此方法經過歌手搜索此歌手下的歌曲。
Load_song:遊客和用戶進入網站時調用此方法來加載一些歌曲。
Add_song:管理員調用此方法來向數據庫中添加歌曲。
Modify_song:管理員調用此方法來修改歌曲信息。
Delete_song:管理員調用此方法來下架歌曲。

3.3 歌單類

屬性	含義
sheet_id	歌單id
sheet_name	歌單名字
owner	歌單擁有者
sheet_img	歌單圖片
play_times	播放次數
info	介紹信息
thumbs_up_num	點贊數
follow_num	關注量

方法：

Add_sheet:用戶調用此方法來添加本身的歌單。
Delete_sheet:用戶調用此方法來刪除本身的歌單。
Load_sheet:遊客或用戶在進入網站時調用此方法來加載一些歌單。
Modify_sheet:用戶調用此方法來修改本身的歌單。
Search_sheet:遊客或用戶調用此方法來搜索歌單。

3.4 用戶類

屬性	含義
user_id	用戶id
user_nickname	用戶暱稱
password	用戶登陸密碼
gender	用戶性別
birthday	用戶生日
motto	用戶個性簽名
info	介紹信息
thumbs_up_num	點贊數
user_type	用戶類型（遊客、普通、管理員）

方法：

Modify_user_info:用戶調用此方法來修改本身的我的簡介（管理員不須要，根本沒人看獲得他）
Register_user:遊客調用此方法來註冊一個新的用戶。
Delete_user:管理員調用此方法來刪除普通用戶，不能刪除管理員。

3.5 評論類

屬性	含義
comment_id	評論id
user_id	該條評論的用戶id
item_type	用於區別此評論在哪裏出現（音樂、圈子、歌單…）
item_id	評論出現地（音樂、圈子、歌單…）的id
content	評論內容
create_time	評論時間
thumbs_up_num	點贊數

方法：

Load_comment:遊客進入歌曲頁面時調用此方法加載歌曲評論，用戶在進入帖子，動態，歌曲頁面時調用此方法加載相應項目的評論。
Add_comment:用戶調用此方法添加對應項目下的評論。
Delete_comment:用戶或管理員調用此方法刪除相應的評論。
Modify_comment:用戶調用此方法來修改評論。
Report_comment:用戶調用此方法對相應評論進行舉報。

3.6 點贊類

屬性	含義
user_id	點贊用戶的id
item_type	點讚的類型（音樂、圈子、歌單…）
item_id	（音樂、圈子、歌單…）的id

方法：

Add_thumbsup:用戶調用此方法對歌手、歌曲、歌單、用戶、評論、帖子、圈子或是動態點贊。
Delete_thumbsup:用戶調用此方法取消對歌手、歌曲、歌單、用戶、評論、帖子、圈子或是動態的點贊。
Is_up:顯示是否已點贊，不顯示的調用。

3.7 關注類

屬性	含義
user_id	用戶id
to_user_id	被關注用戶id

方法：

Add_follow:用戶調用此方法添加對某個用戶的關注。
Delete_follow:用戶調用此方法刪除對某個用戶的關注。
Load_follow:用戶在查看本身關注的人的頁面調用此方法來加載本身所關注的人。
Is_follow:顯示是否已關注，不顯示的調用。

3.8 圈子類

屬性	含義
group_id	圈子id
user_id	圈子建立用戶id
group_name	圈子名稱
create_time	建立時間
info	介紹信息
thumbs_up_num	點贊數
follow_num	關注數

方法：

Add_group:用戶調用此方法來建立一個圈子。
Delete_group:用戶或管理員調用此方法來解散一個圈子。
Load_group:用戶在進入圈子頁面時調用此方法來加載已加入圈子信息。
Invite_user:用戶調用此方法來邀請其餘用戶加入相應圈子。
Manage_group:管理員調用此方法管理圈子

3.9 帖子類

屬性	含義
post_id	帖子id
group_id	帖子所屬圈子id
user_id	發帖用戶id
title	帖子標題
content	帖子內容
create_time	建立時間
recent_time	最新評論發表時間
thumbs_up_num	點贊數

方法：

Add_post:用戶調用此方法來添加帖子。
Load_post:用戶在進入具體圈子後調用此方法來加載該圈子下的帖子信息。
Delete_post:用戶或管理員調用此方法來刪除帖子
Modify_post:用戶調用此方法來修改帖子信息。

3.10 我的動態類

屬性	含義
zone_id	空間動態id
user_id	動態全部者id
create_time	建立時間
content	內容
item_type	動態的類型（音樂、圈子、歌單…）
item_id	（音樂、圈子、歌單…）的id
thumbs_up_num	點贊數