# Group11

**Repository Path**: uaie/Group11

## Basic Information

- **Project Name**: Group11
- **Description**: 11111111111111111
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-02
- **Last Updated**: 2024-01-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 软件工程实践

#### 组号
小组11

#### 用例图
![Image text](https://gitee.com/uaie/Group11/raw/master/UML%E9%9C%80%E6%B1%82%E7%94%A8%E4%BE%8B%E5%9B%BE.png)

#### 用例描述
用户可以进行添加、修改和删除联系人的操作，并且可以通过Android应用、Spring Boot服务器和Web页面来查看他们的联系人。其中，自动同步联系人的功能可以使数据在不同端口之间实现共享和同步，提高用户的使用体验。
#### 用例说明
角色：

用户：使用Android应用、Web页面或Spring Boot服务器来管理和同步联系人。  
场景一：添加联系人

用户打开Android应用或Web页面，并登录账号。
用户选择联系人管理功能。
用户点击添加联系人按钮。
系统显示一个联系人表单，用户填写联系人的姓名、电话号码、电子邮件等信息。
用户点击保存按钮。
系统验证并保存联系人信息。
系统提示联系人添加成功，并刷新联系人列表显示新添加的联系人。  
场景二：修改联系人

用户打开Android应用或Web页面，并登录账号。
用户选择联系人管理功能。
用户浏览联系人列表，选择需要修改的联系人。
用户点击编辑按钮。
系统显示联系人的详细信息，并允许用户修改。
用户修改完毕后，点击保存按钮。
系统验证并更新联系人信息。
系统提示联系人修改成功，并刷新联系人列表显示更新后的联系人信息。  
场景三：删除联系人

用户打开Android应用或Web页面，并登录账号。
用户选择联系人管理功能。
用户浏览联系人列表，选择需要删除的联系人。
用户点击删除按钮。
系统弹出确认对话框，询问用户是否确定删除该联系人。
用户点击确认删除按钮。
系统删除该联系人，并刷新联系人列表显示删除后的联系人信息。
系统提示联系人删除成功。  
场景四：同步联系人

用户打开Android应用或Web页面，并登录账号。
用户选择联系人管理功能。
用户点击同步按钮。
系统检测到数据变化，开始将本地联系人数据与服务器进行同步。
系统上传本地新增、修改和删除的联系人数据至服务器。
服务器接收到数据后，进行验证并更新数据库中的联系人信息。
服务器将更新后的联系人数据返回给用户的设备。
设备接收到服务器返回的数据，更新本地联系人数据，并刷新联系人列表显示最新的联系人信息。
系统提示联系人同步成功。  
注意事项：

在添加、修改或删除联系人时，需要对用户输入的数据进行合法性验证，确保数据的完整性和准确性。
在同步联系人时，需要处理网络连接异常、数据冲突等异常情况，保证数据的一致性和可靠性。
在Android应用、Web页面和Spring Boot服务器之间建立合适的接口和数据传输方式，以实现联系人数据的共享和同步。
用户需要提前注册账号，在登录后才能进行联系人管理和同步操作。

#### ER图
![Image text](https://gitee.com/uaie/Group11/raw/master/ER%E5%9B%BE.png)

#### ER图markdown

```mermaid
erDiagram
    USER {
        int userID
        string userNo
        string password
    }
    CONTACT {
        int contactID
        string name
        string number
    }

    USER }|..|{ CONTACT : has
```

#### 数据流图
![Image text](https://gitee.com/uaie/Group11/raw/master/%E6%95%B0%E6%8D%AE%E6%B5%81%E5%9B%BE.png)


# 系统接口文档
## 一、概述
本文档详细描述了通讯录系统的各种API接口，包括获取用户列表、获取用户详情、创建新用户、编辑用户、以及删除用户等操作。通过这些接口，使用户可以方便地在不同的平台上访问和更新通讯录信息。
## 二、API概览
查找功能
删除功能
编辑功能
增加功能
## 三、API详解

### 1.查找功能 请求方法: GET
 + 请求URL： http://localhost:8080/jpa/students
  接口示例：返回示例：
    
    > [
                        {
                            "id": 1,
                            "telephone": 123213123123,
                            "name": "asd",
                            "gender": "ads",
                            "address": "asd"
                        },
                        {
                            "id": 2,
                            "telephone": 123123,
                            "name": "asd",
                            "gender": "asd",
                            "address": "adsqweq"
                        },
                        {
                            "id": 3,
                            "telephone": 1234,
                            "name": "awds",
                            "gender": "asd",
                            "address": "fsd"
                        }
                ]
            

### 2.删除功能
 + 请求方法： DELETE
  请求URL:http://localhost:8080/mybatis/delete/{id}
    接口示例： 返回示例：
    > 成功

    
### 3.编辑功能
 + 请求方法:  PUT
请求URL:http://localhost:8080/jpa/students
Headers：
Content-Type: application/json
Body： 在Body中选择raw并使用JSON格式，更新用户的信息
接口示例： 请求示例：

    >  {
            "id": 2,
            "name": "Updated Name",
            "telephone": "123123",
            "gender": "Updated Gender",
            "address": "Updated Address"
            }

    返回示例：
    >  成功

### 4.增加功能
 + 请求方法: POST
请求URL:http://localhost:8080/jpa/students
Headers：
Content-Type: application/json
Body： 在Body中选择raw并使用JSON格式，添加要创建的用户的信息。
接口示例： 请求示例：

    >  {
            "name": "John Doe",
            "telephone": "123456789",
            "gender": "Male",
            "address": "123 Main Street"
            }

    返回示例：
    > 成功

## 四、错误处理

因为编辑和增加用户的sql语句未写id，建表的时候若主键id若未设置自动递增，那么在编辑和增加用户信息的时候，系统将返回400错误码，并包含错误信息。将数据表主键id设置自动递增，数据编辑增加返回信息即正常。