# NewCreate（新创）

**Repository Path**: xymtop/newcreate

## Basic Information

- **Project Name**: NewCreate（新创）
- **Description**: NewCreate（新创）
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-12-17
- **Last Updated**: 2023-06-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# back

# 贴心的编码说明如下
1. 请按照当前新建好的目录编码，不需要再新建任何目录，不然显得很乱
2. 下面是当前目录的截图
![img.png](img/img.png)
3.下面是com.xymtop.api下面目录的作用解读
>> aop目录：切片编程代码目录，没有涉及到切片编程不要动
> 
>> config目录：一些应用级配置相关的目录，如拦截器配置等
> 
>> controller目录：控制层目录，包含了后端的api请求的处理和返回
> 
>> entity：实体目录，属于mvc的m层，应该很好理解
> 
>> exception：错误定义目录，这个目录下面的类都应该是错误类，也就是继承自exception类的子类，需要在一些错误的场合抛出

>> implement：实现类，数据库操作相关的接口可以在这里实现
> 
>> mapper：该目录为mybatis的代码层次的目录，关于数据库的操作的接口在这里

>> service：该目录为服务类，该目录的代码很多都可以让控制器层面来调用

>> utils：该目录下的代码为当前项目可以直接使用的工具代码，例如获取时间戳或者时间戳转换等

>> vo：value object层次相关的代码，简单来说就是在数据库连表查询时没有实体可以直接接收数据，使用可以新建一个ov类来接收

>>XymtopApplication:入口类，不能动

4.下面是resource下面目录的作用解读
>> mybatis.mapper：mybatis的xml文件存放目录，不需要改，不然和系统配置对不上

>> static：该目录可存放一些图片，文件和html代码等资源，但是请记得在拦截器中添加白名单

>> templates：我们不需要，不用管

>> application.yml:已经配置好了，不用改了

5.一些常用git命令
```shell
#提交文件到git
git add . 或者 git add 文件名
git commit -m "commit_message"
git push origin branch_name

#更新文件
git pull
```
6.类和变量，函数和接口的命名
```java
//类的命名
//以控制器命名为例，我们更需要UserController这样的命名，而不是userController或者usercontroller或者yonghukongzhiqi

//方法的命名
//我们可能更需要userLogin或者getName这样的，而不是getname,GetName

//变量命名
//我们需要类似于UserId或者userid,user_id,而不是yonghuid,userId

//api接口命名
//我们希望看到 api/user/login而不是Api/User/Login,请尽量小写

//返回值命名
//我们希望返回值的结构为下面这样而不是其他

```

```json
{
  "status": "200",
  "message":"success",
  "data": {
    "id": "10001",
    "password": "123456"
  }
}
```