Skip to content

Commit eb783d1

Browse files
committed
Revert "refactor: refactor the Result Class (apache#7176)"
This reverts commit 01877a9.
1 parent 7396e53 commit eb783d1

File tree

18 files changed

+181
-221
lines changed

18 files changed

+181
-221
lines changed

Diff for: changes/en-us/2.x.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Add changes here for all PR submitted to the 2.x branch.
7272

7373
### refactor:
7474

75-
- [[#7176](https://github.com/apache/incubator-seata/pull/7176)] refactor the Result class
75+
- [[#PR_NO](https://github.com/apache/incubator-seata/pull/PR_NO)] refactor XXX
7676

7777
Thanks to these contributors for their code commits. Please report an unintended omission.
7878

Diff for: changes/zh-cn/2.x.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373
### refactor:
7474

75-
- [[#7176](https://github.com/apache/incubator-seata/pull/7176)] 重构 Result 类
75+
- [[#PR_NO](https://github.com/apache/incubator-seata/pull/PR_NO)] 重构XXX
7676

7777
非常感谢以下 contributors 的代码贡献。若有无意遗漏,请报告。
7878

Diff for: common/src/main/java/org/apache/seata/common/result/Code.java

+22-4
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ public enum Code {
2525
/**
2626
* server error
2727
*/
28-
INTERNAL_SERVER_ERROR("500", "Server error"),
28+
ERROR("500", "Server error"),
2929
/**
3030
* the custom error
3131
*/
32-
UNAUTHORIZED("401", "Login failed");
32+
LOGIN_FAILED("401", "Login failed");
3333

3434
/**
3535
* The Code.
3636
*/
37-
public final String code;
37+
public String code;
3838

3939
/**
4040
* The Msg.
4141
*/
42-
public final String msg;
42+
public String msg;
4343

4444
private Code(String code, String msg) {
4545
this.code = code;
@@ -55,6 +55,15 @@ public String getCode() {
5555
return this.code;
5656
}
5757

58+
/**
59+
* Sets code.
60+
*
61+
* @param code the code
62+
*/
63+
public void setCode(String code) {
64+
this.code = code;
65+
}
66+
5867
/**
5968
* Gets msg.
6069
*
@@ -64,6 +73,15 @@ public String getMsg() {
6473
return msg;
6574
}
6675

76+
/**
77+
* Sets msg.
78+
*
79+
* @param msg the msg
80+
*/
81+
public void setMsg(String msg) {
82+
this.msg = msg;
83+
}
84+
6785
/**
6886
* Gets error msg.
6987
*

Diff for: common/src/main/java/org/apache/seata/common/result/PageResult.java

+15-17
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616
*/
1717
package org.apache.seata.common.result;
1818

19-
import static org.apache.seata.common.result.Code.SUCCESS;
20-
19+
import java.io.Serializable;
2120
import java.util.List;
2221

2322
/**
2423
* The page result
24+
*
2525
*/
26-
public class PageResult<T> extends Result {
26+
public class PageResult<T> extends Result<T> implements Serializable {
2727
private static final long serialVersionUID = 7761262662429121287L;
2828

2929
/**
@@ -55,7 +55,7 @@ public PageResult(String code, String message) {
5555
}
5656

5757
public PageResult(List<T> data, Integer total, Integer pages, Integer pageNum, Integer pageSize) {
58-
super(SUCCESS.code, SUCCESS.msg);
58+
super(SUCCESS_CODE, SUCCESS_MSG);
5959
this.total = total;
6060
this.pages = pages;
6161
this.pageNum = pageNum;
@@ -71,19 +71,19 @@ public static <T> PageResult<T> build(List<T> list, Integer pageNum, Integer pag
7171
}
7272
final int offset = pageSize * (pageNum - 1);
7373
return PageResult.success(
74-
list.subList(
75-
Math.min(offset, list.size()),
76-
Math.min(offset + pageSize, list.size())
77-
),
78-
list.size(),
79-
pages,
80-
pageNum,
81-
pageSize
74+
list.subList(
75+
Math.min(offset, list.size()),
76+
Math.min(offset + pageSize, list.size())
77+
),
78+
list.size(),
79+
pages,
80+
pageNum,
81+
pageSize
8282
);
8383
}
8484

8585
public PageResult(List<T> data, Integer total, Integer pageNum, Integer pageSize) {
86-
super(SUCCESS.code, SUCCESS.msg);
86+
super(SUCCESS_CODE, SUCCESS_MSG);
8787
this.total = total;
8888
this.pageNum = pageNum;
8989
this.pageSize = pageSize;
@@ -101,14 +101,12 @@ public static <T> PageResult<T> failure(String code, String msg) {
101101
}
102102

103103
public static <T> PageResult<T> success() {
104-
return new PageResult<>(SUCCESS.code, SUCCESS.msg);
104+
return new PageResult<>(SUCCESS_CODE, SUCCESS_MSG);
105105
}
106106

107-
public static <T> PageResult<T> success(List<T> data, Integer total, Integer pages, Integer pageNum,
108-
Integer pageSize) {
107+
public static <T> PageResult<T> success(List<T> data, Integer total, Integer pages, Integer pageNum, Integer pageSize) {
109108
return new PageResult<>(data, total, pages, pageNum, pageSize);
110109
}
111-
112110
public static <T> PageResult<T> success(List<T> data, Integer total, Integer pageNum, Integer pageSize) {
113111
return new PageResult<>(data, total, pageNum, pageSize);
114112
}

Diff for: common/src/main/java/org/apache/seata/common/result/Result.java

+18-7
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,23 @@
1616
*/
1717
package org.apache.seata.common.result;
1818

19-
import static org.apache.seata.common.result.Code.SUCCESS;
20-
2119
import java.io.Serializable;
2220

2321
/**
2422
* The basic result
2523
*/
26-
public class Result implements Serializable {
24+
public class Result<T> implements Serializable {
2725
private static final long serialVersionUID = 7761261124298767L;
2826

29-
private final String code;
30-
private final String message;
27+
public static final String SUCCESS_CODE = "200";
28+
public static final String SUCCESS_MSG = "success";
29+
public static final String FAIL_CODE = "500";
30+
31+
32+
private String code = SUCCESS_CODE;
33+
private String message = SUCCESS_MSG;
3134

3235
public Result() {
33-
this(null, null);
3436
}
3537

3638
public Result(String code, String message) {
@@ -39,14 +41,23 @@ public Result(String code, String message) {
3941
}
4042

4143
public boolean isSuccess() {
42-
return this.code.equals(SUCCESS.code);
44+
return SUCCESS_CODE.equals(this.code);
4345
}
4446

4547
public String getCode() {
4648
return code;
4749
}
4850

51+
public void setCode(String code) {
52+
this.code = code;
53+
}
54+
4955
public String getMessage() {
5056
return message;
5157
}
58+
59+
public void setMessage(String message) {
60+
this.message = message;
61+
}
62+
5263
}

Diff for: common/src/main/java/org/apache/seata/common/result/SingleResult.java

+13-17
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,18 @@
1616
*/
1717
package org.apache.seata.common.result;
1818

19-
import static org.apache.seata.common.result.Code.SUCCESS;
20-
import static org.apache.seata.common.result.Code.INTERNAL_SERVER_ERROR;
19+
import java.io.Serializable;
20+
2121

2222
/**
2323
* The single result
2424
*/
25-
public class SingleResult<T> extends Result {
25+
public class SingleResult<T> extends Result<T> implements Serializable {
2626
private static final long serialVersionUID = 77612626624298767L;
2727

28+
/**
29+
* the data
30+
*/
2831
private T data;
2932

3033
public SingleResult(String code, String message) {
@@ -41,34 +44,27 @@ public static <T> SingleResult<T> failure(String code, String msg) {
4144
}
4245

4346
public static <T> SingleResult<T> failure(Code errorCode) {
44-
return failure(errorCode.code, errorCode.msg);
47+
return new SingleResult(errorCode.getCode(), errorCode.getMsg());
4548
}
4649

4750
public static <T> SingleResult<T> failure(String msg) {
48-
return failure(INTERNAL_SERVER_ERROR.code, msg);
49-
}
50-
51-
public static <T> SingleResult<T> success(String msg, T data) {
52-
return new SingleResult<>(SUCCESS.code, msg, data);
51+
return new SingleResult<>(FAIL_CODE, msg);
5352
}
5453

55-
public static SingleResult<Void> success(String msg) {
56-
return success(msg, null);
54+
public static <T> SingleResult<T> success(T data) {
55+
return new SingleResult<>(SUCCESS_CODE, SUCCESS_MSG,data);
5756
}
5857

5958
public static <T> SingleResult<T> success() {
60-
return success(SUCCESS.msg, null);
61-
}
62-
63-
public static <T> SingleResult<T> successWithData(T data) {
64-
return success(SUCCESS.msg, data);
59+
return new SingleResult<>(SUCCESS_CODE, SUCCESS_MSG, null);
6560
}
6661

6762
public T getData() {
6863
return data;
6964
}
7065

71-
public void setData(final T data) {
66+
public void setData(T data) {
7267
this.data = data;
7368
}
69+
7470
}

Diff for: common/src/test/java/org/apache/seata/common/code/CodeTest.java

+13-4
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,24 @@ public class CodeTest {
2828
public void testGetErrorMsgWithValidCodeReturnsExpectedMsg() {
2929
// Test case for SUCCESS
3030
assertEquals("ok", Code.SUCCESS.getMsg());
31-
// Test case for INTERNAL_SERVER_ERROR
32-
assertEquals("Server error", Code.INTERNAL_SERVER_ERROR.getMsg());
33-
// Test case for UNAUTHORIZED
34-
assertEquals("Login failed", Code.UNAUTHORIZED.getMsg());
31+
// Test case for ERROR
32+
assertEquals("Server error", Code.ERROR.getMsg());
33+
// Test case for LOGIN_FAILED
34+
assertEquals("Login failed", Code.LOGIN_FAILED.getMsg());
3535
}
3636

3737
@Test
3838
public void testGetErrorMsgWithInvalidCodeReturnsNull() {
3939
// Test case for non-existing code
4040
assertNull(Code.getErrorMsg("404"));
4141
}
42+
43+
@Test
44+
public void testSetCodeAndMsgUpdatesValuesCorrectly() {
45+
// Test case to check if setCode and setMsg are working as expected
46+
Code.SUCCESS.setCode("201");
47+
Code.SUCCESS.setMsg("Created");
48+
assertEquals("201", Code.SUCCESS.getCode());
49+
assertEquals("Created", Code.SUCCESS.getMsg());
50+
}
4251
}

Diff for: common/src/test/java/org/apache/seata/common/result/PageResultTest.java

+10-11
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
import org.mockito.InjectMocks;
2424
import org.mockito.MockitoAnnotations;
2525

26-
import static org.apache.seata.common.result.Code.*;
2726
import static org.junit.jupiter.api.Assertions.assertEquals;
2827
import static org.junit.jupiter.api.Assertions.assertNull;
2928

@@ -42,7 +41,7 @@ void buildPageSizeDivisibleByListSize() {
4241
for (long i = 0; i < 100; i++) {
4342
list.add(i);
4443
}
45-
PageResult<Long> pageResult = PageResult.build(list, 1, 10);
44+
PageResult pageResult = PageResult.build(list, 1, 10);
4645
assertEquals(10, pageResult.getPages());
4746
assertEquals(10, pageResult.getData().size());
4847
}
@@ -53,7 +52,7 @@ void buildPageSizeNotDivisibleByListSize() {
5352
for (long i = 0; i < 9; i++) {
5453
list.add(i);
5554
}
56-
PageResult<Long> pageResult = PageResult.build(list, 1, 10);
55+
PageResult pageResult = PageResult.build(list, 1, 10);
5756
assertEquals(1, pageResult.getPages());
5857
assertEquals(9, pageResult.getData().size());
5958
}
@@ -64,24 +63,24 @@ void buildPageNumGreaterThanTotalPages() {
6463
for (long i = 0; i < 5; i++) {
6564
list.add(i);
6665
}
67-
PageResult<Long> pageResult = PageResult.build(list, 10, 2);
66+
PageResult pageResult = PageResult.build(list, 10, 2);
6867
assertEquals(10, pageResult.getPageNum().intValue());
6968
assertEquals(3, pageResult.getPages().intValue());
7069
assertEquals(0, pageResult.getData().size());
7170
}
7271

7372
@Test
7473
void failureInvalidParams() {
75-
PageResult<Void> pageResult = PageResult.failure("400", "error");
74+
PageResult pageResult = PageResult.failure("400", "error");
7675
assertEquals("400", pageResult.getCode());
7776
assertEquals("error", pageResult.getMessage());
7877
}
7978

8079
@Test
8180
void successNoData() {
82-
PageResult<Void> pageResult = PageResult.success();
83-
assertEquals(SUCCESS.code, pageResult.getCode());
84-
assertEquals(SUCCESS.msg, pageResult.getMessage());
81+
PageResult pageResult = PageResult.success();
82+
assertEquals(PageResult.SUCCESS_CODE, pageResult.getCode());
83+
assertEquals(PageResult.SUCCESS_MSG, pageResult.getMessage());
8584
assertNull(pageResult.getData());
8685
}
8786

@@ -91,9 +90,9 @@ void successWithData() {
9190
for (long i = 0; i < 5; i++) {
9291
list.add(i);
9392
}
94-
PageResult<Long> pageResult = PageResult.success(list, 5, 1, 5);
95-
assertEquals(SUCCESS.code, pageResult.getCode());
96-
assertEquals(SUCCESS.msg, pageResult.getMessage());
93+
PageResult pageResult = PageResult.success(list, 5, 1, 5);
94+
assertEquals(PageResult.SUCCESS_CODE, pageResult.getCode());
95+
assertEquals(PageResult.SUCCESS_MSG, pageResult.getMessage());
9796
assertEquals(5, pageResult.getTotal().intValue());
9897
assertEquals(1, pageResult.getPageNum().intValue());
9998
assertEquals(5, pageResult.getPageSize().intValue());

0 commit comments

Comments
 (0)