Skip to content

Commit 644d495

Browse files
authored
Merge pull request #26 from TaleLin/refactor/change-response-vo
Refactor/change response vo
2 parents 4c7ab46 + 9225b36 commit 644d495

7 files changed

Lines changed: 59 additions & 55 deletions

File tree

src/main/java/io/github/talelin/merak/controller/cms/AdminController.java

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,9 @@
88
import io.github.talelin.merak.model.UserDO;
99
import io.github.talelin.merak.service.AdminService;
1010
import io.github.talelin.merak.service.GroupService;
11-
import io.github.talelin.merak.vo.UnifyResponseVO;
12-
import io.github.talelin.merak.vo.PageResponseVO;
11+
import io.github.talelin.merak.vo.*;
1312
import io.github.talelin.merak.model.GroupDO;
1413
import io.github.talelin.merak.dto.admin.*;
15-
import io.github.talelin.merak.vo.UserInfoVO;
1614
import org.springframework.beans.factory.annotation.Autowired;
1715
import org.springframework.validation.annotation.Validated;
1816
import org.springframework.web.bind.annotation.*;
@@ -63,23 +61,23 @@ public PageResponseVO getUsers(
6361

6462
@PutMapping("/user/{id}/password")
6563
@AdminMeta(permission = "修改用户密码", module = "管理员")
66-
public UnifyResponseVO changeUserPassword(@PathVariable @Positive(message = "{id}") Long id, @RequestBody @Validated ResetPasswordDTO validator) {
64+
public UpdatedVO changeUserPassword(@PathVariable @Positive(message = "{id}") Long id, @RequestBody @Validated ResetPasswordDTO validator) {
6765
adminService.changeUserPassword(id, validator);
68-
return ResponseUtil.generateUnifyResponse(4);
66+
return new UpdatedVO(4);
6967
}
7068

7169
@DeleteMapping("/user/{id}")
7270
@AdminMeta(permission = "删除用户", module = "管理员")
73-
public UnifyResponseVO deleteUser(@PathVariable @Positive(message = "{id}") Long id) {
71+
public DeletedVO deleteUser(@PathVariable @Positive(message = "{id}") Long id) {
7472
adminService.deleteUser(id);
75-
return ResponseUtil.generateUnifyResponse(5);
73+
return new DeletedVO(5);
7674
}
7775

7876
@PutMapping("/user/{id}")
7977
@AdminMeta(permission = "管理员更新用户信息", module = "管理员")
80-
public UnifyResponseVO updateUser(@PathVariable @Positive(message = "{id}") Long id, @RequestBody @Validated UpdateUserInfoDTO validator) {
78+
public UpdatedVO updateUser(@PathVariable @Positive(message = "{id}") Long id, @RequestBody @Validated UpdateUserInfoDTO validator) {
8179
adminService.updateUserInfo(id, validator);
82-
return ResponseUtil.generateUnifyResponse(6);
80+
return new UpdatedVO(6);
8381
}
8482

8583
@GetMapping("/group")
@@ -109,45 +107,45 @@ public GroupPermissionBO getGroup(@PathVariable @Positive(message = "{id}") Long
109107

110108
@PostMapping("/group")
111109
@AdminMeta(permission = "新建权限组", module = "管理员")
112-
public UnifyResponseVO createGroup(@RequestBody @Validated NewGroupDTO validator) {
110+
public CreatedVO createGroup(@RequestBody @Validated NewGroupDTO validator) {
113111
adminService.createGroup(validator);
114-
return ResponseUtil.generateUnifyResponse(15);
112+
return new CreatedVO(15);
115113
}
116114

117115
@PutMapping("/group/{id}")
118116
@AdminMeta(permission = "更新一个权限组", module = "管理员")
119-
public UnifyResponseVO updateGroup(@PathVariable @Positive(message = "{id}") Long id,
117+
public UpdatedVO updateGroup(@PathVariable @Positive(message = "{id}") Long id,
120118
@RequestBody @Validated UpdateGroupDTO validator) {
121119
adminService.updateGroup(id, validator);
122-
return ResponseUtil.generateUnifyResponse(7);
120+
return new UpdatedVO(7);
123121
}
124122

125123
@DeleteMapping("/group/{id}")
126124
@AdminMeta(permission = "删除一个权限组", module = "管理员")
127-
public UnifyResponseVO deleteGroup(@PathVariable @Positive(message = "{id}") Long id) {
125+
public DeletedVO deleteGroup(@PathVariable @Positive(message = "{id}") Long id) {
128126
adminService.deleteGroup(id);
129-
return ResponseUtil.generateUnifyResponse(8);
127+
return new DeletedVO(8);
130128
}
131129

132130
@PostMapping("/permission/dispatch")
133131
@AdminMeta(permission = "分配单个权限", module = "管理员")
134-
public UnifyResponseVO dispatchPermission(@RequestBody @Validated DispatchPermissionDTO validator) {
132+
public CreatedVO dispatchPermission(@RequestBody @Validated DispatchPermissionDTO validator) {
135133
adminService.dispatchPermission(validator);
136-
return ResponseUtil.generateUnifyResponse(9);
134+
return new CreatedVO(9);
137135
}
138136

139137
@PostMapping("/permission/dispatch/batch")
140138
@AdminMeta(permission = "分配多个权限", module = "管理员")
141-
public UnifyResponseVO dispatchPermissions(@RequestBody @Validated DispatchPermissionsDTO validator) {
139+
public CreatedVO dispatchPermissions(@RequestBody @Validated DispatchPermissionsDTO validator) {
142140
adminService.dispatchPermissions(validator);
143-
return ResponseUtil.generateUnifyResponse(9);
141+
return new CreatedVO(9);
144142
}
145143

146144
@PostMapping("/permission/remove")
147145
@AdminMeta(permission = "删除多个权限", module = "管理员")
148-
public UnifyResponseVO removePermissions(@RequestBody @Validated RemovePermissionsDTO validator) {
146+
public DeletedVO removePermissions(@RequestBody @Validated RemovePermissionsDTO validator) {
149147
adminService.removePermissions(validator);
150-
return ResponseUtil.generateUnifyResponse(10);
148+
return new DeletedVO(10);
151149
}
152150

153151
}

src/main/java/io/github/talelin/merak/controller/cms/UserController.java

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
package io.github.talelin.merak.controller.cms;
22

3-
import io.github.talelin.core.annotation.*;
4-
import io.github.talelin.merak.common.LocalUser;
5-
import io.github.talelin.merak.common.util.ResponseUtil;
6-
import io.github.talelin.merak.model.GroupDO;
7-
import io.github.talelin.merak.service.GroupService;
8-
import io.github.talelin.merak.service.UserIdentityService;
9-
import io.github.talelin.merak.vo.UnifyResponseVO;
10-
import io.github.talelin.merak.model.UserDO;
11-
import io.github.talelin.merak.vo.UserInfoVO;
12-
import io.github.talelin.merak.vo.UserPermissionVO;
13-
import io.github.talelin.merak.service.UserService;
14-
import io.github.talelin.core.token.DoubleJWT;
15-
import io.github.talelin.core.token.Tokens;
163
import io.github.talelin.autoconfigure.exception.NotFoundException;
174
import io.github.talelin.autoconfigure.exception.ParameterException;
5+
import io.github.talelin.core.annotation.AdminRequired;
6+
import io.github.talelin.core.annotation.LoginMeta;
7+
import io.github.talelin.core.annotation.LoginRequired;
8+
import io.github.talelin.core.annotation.RefreshRequired;
9+
import io.github.talelin.core.token.DoubleJWT;
10+
import io.github.talelin.core.token.Tokens;
11+
import io.github.talelin.merak.common.LocalUser;
1812
import io.github.talelin.merak.dto.user.ChangePasswordDTO;
1913
import io.github.talelin.merak.dto.user.LoginDTO;
2014
import io.github.talelin.merak.dto.user.RegisterDTO;
2115
import io.github.talelin.merak.dto.user.UpdateInfoDTO;
16+
import io.github.talelin.merak.model.GroupDO;
17+
import io.github.talelin.merak.model.UserDO;
18+
import io.github.talelin.merak.service.GroupService;
19+
import io.github.talelin.merak.service.UserIdentityService;
20+
import io.github.talelin.merak.service.UserService;
21+
import io.github.talelin.merak.vo.CreatedVO;
22+
import io.github.talelin.merak.vo.UpdatedVO;
23+
import io.github.talelin.merak.vo.UserInfoVO;
24+
import io.github.talelin.merak.vo.UserPermissionVO;
2225
import org.springframework.beans.factory.annotation.Autowired;
2326
import org.springframework.validation.annotation.Validated;
2427
import org.springframework.web.bind.annotation.*;
@@ -51,9 +54,9 @@ public class UserController {
5154
*/
5255
@PostMapping("/register")
5356
@AdminRequired
54-
public UnifyResponseVO<String> register(@RequestBody @Validated RegisterDTO validator) {
57+
public CreatedVO<String> register(@RequestBody @Validated RegisterDTO validator) {
5558
userService.createUser(validator);
56-
return ResponseUtil.generateUnifyResponse(11);
59+
return new CreatedVO(11);
5760
}
5861

5962
/**
@@ -79,19 +82,19 @@ public Tokens login(@RequestBody @Validated LoginDTO validator) {
7982
*/
8083
@PutMapping
8184
@LoginRequired
82-
public UnifyResponseVO update(@RequestBody @Validated UpdateInfoDTO validator) {
85+
public UpdatedVO update(@RequestBody @Validated UpdateInfoDTO validator) {
8386
userService.updateUserInfo(validator);
84-
return ResponseUtil.generateUnifyResponse(6);
87+
return new UpdatedVO(6);
8588
}
8689

8790
/**
8891
* 修改密码
8992
*/
9093
@PutMapping("/change_password")
9194
@LoginRequired
92-
public UnifyResponseVO updatePassword(@RequestBody @Validated ChangePasswordDTO validator) {
95+
public UpdatedVO updatePassword(@RequestBody @Validated ChangePasswordDTO validator) {
9396
userService.changeUserPassword(validator);
94-
return ResponseUtil.generateUnifyResponse(4);
97+
return new UpdatedVO(4);
9598
}
9699

97100
/**

src/main/java/io/github/talelin/merak/controller/v1/BookController.java

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
package io.github.talelin.merak.controller.v1;
22

3+
import io.github.talelin.autoconfigure.exception.NotFoundException;
34
import io.github.talelin.core.annotation.GroupMeta;
5+
import io.github.talelin.merak.dto.book.CreateOrUpdateBookDTO;
46
import io.github.talelin.merak.model.BookDO;
57
import io.github.talelin.merak.service.BookService;
6-
import io.github.talelin.merak.dto.book.CreateOrUpdateBookDTO;
7-
import io.github.talelin.merak.vo.UnifyResponseVO;
8-
import io.github.talelin.autoconfigure.exception.NotFoundException;
9-
import io.github.talelin.merak.common.util.ResponseUtil;
8+
import io.github.talelin.merak.vo.CreatedVO;
9+
import io.github.talelin.merak.vo.DeletedVO;
10+
import io.github.talelin.merak.vo.UpdatedVO;
1011
import org.springframework.beans.factory.annotation.Autowired;
1112
import org.springframework.validation.annotation.Validated;
1213
import org.springframework.web.bind.annotation.*;
@@ -49,32 +50,32 @@ public List<BookDO> searchBook(@RequestParam(value = "q", required = false, defa
4950

5051

5152
@PostMapping("")
52-
public UnifyResponseVO createBook(@RequestBody @Validated CreateOrUpdateBookDTO validator) {
53+
public CreatedVO createBook(@RequestBody @Validated CreateOrUpdateBookDTO validator) {
5354
bookService.createBook(validator);
54-
return ResponseUtil.generateUnifyResponse(12);
55+
return new CreatedVO(12);
5556
}
5657

5758

5859
@PutMapping("/{id}")
59-
public UnifyResponseVO updateBook(@PathVariable("id") @Positive(message = "{id}") Long id, @RequestBody @Validated CreateOrUpdateBookDTO validator) {
60+
public UpdatedVO updateBook(@PathVariable("id") @Positive(message = "{id}") Long id, @RequestBody @Validated CreateOrUpdateBookDTO validator) {
6061
BookDO book = bookService.getById(id);
6162
if (book == null) {
6263
throw new NotFoundException("book not found", 10022);
6364
}
6465
bookService.updateBook(book, validator);
65-
return ResponseUtil.generateUnifyResponse(13);
66+
return new UpdatedVO(13);
6667
}
6768

6869

6970
@DeleteMapping("/{id}")
7071
@GroupMeta(permission = "删除图书", module = "图书", mount = true)
71-
public UnifyResponseVO deleteBook(@PathVariable("id") @Positive(message = "{id}") Long id) {
72+
public DeletedVO deleteBook(@PathVariable("id") @Positive(message = "{id}") Long id) {
7273
BookDO book = bookService.getById(id);
7374
if (book == null) {
7475
throw new NotFoundException("book not found", 10022);
7576
}
7677
bookService.deleteById(book.getId());
77-
return ResponseUtil.generateUnifyResponse(14);
78+
return new DeletedVO(14);
7879
}
7980

8081

src/main/java/io/github/talelin/merak/dto/admin/UpdateGroupDTO.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
import io.github.talelin.autoconfigure.validator.Length;
44
import lombok.Data;
5+
import javax.validation.constraints.NotBlank;
56

67
/**
78
* @author pedro@TaleLin
89
*/
910
@Data
1011
public class UpdateGroupDTO {
1112

13+
@NotBlank(message = "{group.name.not-blank}")
1214
@Length(min = 1, max = 60, message = "{group.name.length}")
1315
private String name;
1416

src/test/java/io/github/talelin/merak/controller/cms/AdminControllerTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ public void createGroup() throws Exception {
303303
mvc.perform(post("/cms/admin/group/")
304304
.contentType(MediaType.APPLICATION_JSON).content(content))
305305
.andDo(print())
306-
.andExpect(status().isOk())
306+
.andExpect(status().isCreated())
307307
.andExpect(MockMvcResultMatchers.jsonPath("$.message").value("新建分组成功"));
308308
}
309309

@@ -384,7 +384,7 @@ public void dispatchPermission() throws Exception {
384384
mvc.perform(post("/cms/admin/permission/dispatch")
385385
.contentType(MediaType.APPLICATION_JSON).content(content))
386386
.andDo(print())
387-
.andExpect(status().isOk())
387+
.andExpect(status().isCreated())
388388
.andExpect(MockMvcResultMatchers.jsonPath("$.message").value("添加权限成功"));
389389
}
390390

@@ -414,7 +414,7 @@ public void dispatchPermissions() throws Exception {
414414
mvc.perform(post("/cms/admin/permission/dispatch/batch")
415415
.contentType(MediaType.APPLICATION_JSON).content(content))
416416
.andDo(print())
417-
.andExpect(status().isOk())
417+
.andExpect(status().isCreated())
418418
.andExpect(MockMvcResultMatchers.jsonPath("$.message").value("添加权限成功"));
419419
}
420420

src/test/java/io/github/talelin/merak/controller/cms/UserControllerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public void register() throws Exception {
9393
mvc.perform(post("/cms/user/register")
9494
.contentType(MediaType.APPLICATION_JSON).content(content))
9595
.andDo(print())
96-
.andExpect(status().isOk())
96+
.andExpect(status().isCreated())
9797
.andExpect(MockMvcResultMatchers.
9898
jsonPath("$.message").value("注册成功"));
9999
}

src/test/java/io/github/talelin/merak/controller/v1/BookControllerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ public void createBook() throws Exception {
117117
mvc.perform(post("/v1/book/")
118118
.contentType(MediaType.APPLICATION_JSON).content(content))
119119
.andDo(print())
120-
.andExpect(status().isOk())
120+
.andExpect(status().isCreated())
121121
.andExpect(MockMvcResultMatchers.
122122
jsonPath("$.message").value("新建图书成功"));
123123
}

0 commit comments

Comments
 (0)