R (yue-library-码云(gitee.com))

java.lang.Object
- ai.yue.library.base.view.R

```
public class R
extends Object
```
便捷返回 Result，构建 RESTful 风格API结果

Since:

2017年7月31日

Author:

ylyue

Constructor Summary

Constructors
Constructor and Description

R()

Constructors
Constructor and Description
`R()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Result<?>`	`attack()` 非法访问-402
`static <T> Result<T>`	`attack(T data)` 非法访问-402
`static Result<?>`	`clientFallback()` 哎哟喂！网络开小差了，请稍后重试...-507
`static <T> Result<T>`	`clientFallback(T data)` 哎哟喂！网络开小差了，请稍后重试...-507
`static Result<?>`	`clientFallbackError()` 哎哟喂！服务都被您挤爆了...-508
`static <T> Result<T>`	`clientFallbackError(T data)` 哎哟喂！服务都被您挤爆了...-508
`static Result<?>`	`dataStructure()` 数据结构异常-505
`static Result<?>`	`dataStructure(int expected, int actual)` 数据结构异常-505
`static Result<?>`	`dbError()` 数据结构异常，请检查相应数据结构一致性-506
`static <T> Result<T>`	`dbError(T data)` 数据结构异常，请检查相应数据结构一致性-506
`static Result<?>`	`errorPrompt(String msg)` 错误提示-600
`static <T> Result<T>`	`errorPrompt(String msg, T data)` 错误提示-600
`static Result<?>`	`errorPromptFormat(String msg, Object... values)` 错误提示-600
`static Result<?>`	`fileEmpty()` 文件上传请求错误，获得文件信息为空，同时文件必须有明确的匹配类型（如文本类型：.txt）-310
`static Result<?>`	`forbidden()` 无权限-403
`static Result<?>`	`getResult(Throwable e)`
`static Result<?>`	`gone()` API接口版本弃用-410
`static Result<?>`	`internalServerError()` 服务器内部错误-500
`static <T> Result<T>`	`internalServerError(T data)` 服务器内部错误-500
`static Result<?>`	`loggedIn()` 会话未注销，无需登录-210
`static <T> Result<T>`	`methodNotAllowed(T data)` 方法不允许（Method Not Allowed）-405
`static Result<?>`	`movedPermanently()` Moved Permanently-301
`static Result<?>`	`notFound()` Not Found-404
`static Result<?>`	`paramCheckNotPass()` 参数校验未通过，请参照API核对后重试-433
`static <T> Result<T>`	`paramCheckNotPass(T data)` 参数校验未通过，请参照API核对后重试-433
`static Result<?>`	`paramDecryptError()` 参数解密错误-435
`static Result<?>`	`paramValueInvalid()` 参数校验未通过，无效的value-434
`static <T> Result<T>`	`paramValueInvalid(T data)` 参数校验未通过，无效的value-434
`static Result<?>`	`paramVoid()` 参数为空-432
`static Result<?>`	`requestError()` 请求错误-501
`static <T> Result<T>`	`requestError(T data)` 请求错误-501
`static Result<?>`	`resourceAlreadyInvalid()` 资源已失效-300
`static Result<?>`	`serviceUnavailable()` 服务不可用-503
`static Result<?>`	`serviceUnavailable(LocalDateTime restoreTime)` 服务不可用（停机维护）-503
`static <T> Result<T>`	`serviceUnavailable(T data)` 服务不可用-503
`static Result<?>`	`success()` 成功后调用，返回的data为null
`static <T> Result<T>`	`success(Integer code, Long count, T data)` 成功后调用，分页查询
`static <T> Result<T>`	`success(Long count, T data)` 成功后调用，分页查询
`static <T> Result<T>`	`success(T data)` 成功后调用，返回的data为一个对象
`static Result<?>`	`tooManyRequests()` 频繁请求限流-429
`static <T> Result<T>`	`typeConvertError(T data)` 类型转换错误-509
`static Result<?>`	`unauthorized()` 未登录或登录已失效-401

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - R
```
public R()
```
- Method Detail
  - success
```
public static Result<?> success()
```
    成功后调用，返回的data为null
    
    Returns:
    
    HTTP请求，最外层响应对象
  - success
```
public static <T> Result<T> success(T data)
```
    成功后调用，返回的data为一个对象
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    data - 数据
    
    Returns:
    
    HTTP请求，最外层响应对象
  - success
```
public static <T> Result<T> success(Long count,
                                    T data)
```
    成功后调用，分页查询
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    count - 总数
    
    data - 数据
    
    Returns:
    
    HTTP请求，最外层响应对象
  - success
```
public static <T> Result<T> success(Integer code,
                                    Long count,
                                    T data)
```
    成功后调用，分页查询
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    code - 自定义code（默认200）
    
    count - 总数
    
    data - 数据
    
    Returns:
    
    HTTP请求，最外层响应对象
  - loggedIn
```
public static Result<?> loggedIn()
```
    会话未注销，无需登录-210
    
    Returns:
    
    HTTP请求，最外层响应对象
  - resourceAlreadyInvalid
```
public static Result<?> resourceAlreadyInvalid()
```
    资源已失效-300
    
    Returns:
    
    HTTP请求，最外层响应对象
  - movedPermanently
```
public static Result<?> movedPermanently()
```
    Moved Permanently-301
    
    Returns:
    
    HTTP请求，最外层响应对象
  - fileEmpty
```
public static Result<?> fileEmpty()
```
    文件上传请求错误，获得文件信息为空，同时文件必须有明确的匹配类型（如文本类型：.txt）-310
    
    Returns:
    
    HTTP请求，最外层响应对象
  - unauthorized
```
public static Result<?> unauthorized()
```
    未登录或登录已失效-401
    
    Returns:
    
    HTTP请求，最外层响应对象
  - attack
```
public static Result<?> attack()
```
    非法访问-402
    
    Returns:
    
    HTTP请求，最外层响应对象
  - attack
```
public static <T> Result<T> attack(T data)
```
    非法访问-402
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    data - 异常数据
    
    Returns:
    
    HTTP请求，最外层响应对象
  - forbidden
```
public static Result<?> forbidden()
```
    无权限-403
    
    Returns:
    
    HTTP请求，最外层响应对象
  - notFound
```
public static Result<?> notFound()
```
    Not Found-404
    
    Returns:
    
    HTTP请求，最外层响应对象
  - methodNotAllowed
```
public static <T> Result<T> methodNotAllowed(T data)
```
    方法不允许（Method Not Allowed）-405
    客户端使用服务端不支持的 Http Request Method 进行接口调用
    
    Parameters:
    
    data - Result#setData(Object) 更详细的异常提示信息
    
    Returns:
    
    HTTP请求，最外层响应对象
  - gone
```
public static Result<?> gone()
```
    API接口版本弃用-410
    
    Returns:
    
    HTTP请求，最外层响应对象
  - tooManyRequests
```
public static Result<?> tooManyRequests()
```
    频繁请求限流-429
    
    Returns:
    
    HTTP请求，最外层响应对象
  - paramVoid
```
public static Result<?> paramVoid()
```
    参数为空-432
    
    Returns:
    
    HTTP请求，最外层响应对象
  - paramCheckNotPass
```
public static Result<?> paramCheckNotPass()
```
    参数校验未通过，请参照API核对后重试-433
    
    Returns:
    
    HTTP请求，最外层响应对象
  - paramCheckNotPass
```
public static <T> Result<T> paramCheckNotPass(T data)
```
    参数校验未通过，请参照API核对后重试-433
    
    Parameters:
    
    data - Result#setData(Object) 提示信息
    
    Returns:
    
    HTTP请求，最外层响应对象
  - paramValueInvalid
```
public static Result<?> paramValueInvalid()
```
    参数校验未通过，无效的value-434
    
    Returns:
    
    HTTP请求，最外层响应对象
  - paramValueInvalid
```
public static <T> Result<T> paramValueInvalid(T data)
```
    参数校验未通过，无效的value-434
    
    Parameters:
    
    data - Result#setData(Object) 提示信息
    
    Returns:
    
    HTTP请求，最外层响应对象
  - paramDecryptError
```
public static Result<?> paramDecryptError()
```
    参数解密错误-435
    
    Returns:
    
    HTTP请求，最外层响应对象
  - internalServerError
```
public static Result<?> internalServerError()
```
    服务器内部错误-500
    
    Returns:
    
    HTTP请求，最外层响应对象
  - internalServerError
```
public static <T> Result<T> internalServerError(T data)
```
    服务器内部错误-500
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    data - 异常数据
    
    Returns:
    
    HTTP请求，最外层响应对象
  - requestError
```
public static Result<?> requestError()
```
    请求错误-501
    
    Returns:
    
    HTTP请求，最外层响应对象
  - requestError
```
public static <T> Result<T> requestError(T data)
```
    请求错误-501
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    data - 异常数据
    
    Returns:
    
    HTTP请求，最外层响应对象
  - serviceUnavailable
```
public static Result<?> serviceUnavailable()
```
    服务不可用-503
    服务目前无法使用（由于超载或停机维护）
    
    Returns:
    
    HTTP请求，最外层响应对象
  - serviceUnavailable
```
public static Result<?> serviceUnavailable(LocalDateTime restoreTime)
```
    服务不可用（停机维护）-503
    
    Parameters:
    
    restoreTime - 预计恢复时间（如：2020-12-31 08:00:00）
    
    Returns:
    
    HTTP请求，最外层响应对象
  - serviceUnavailable
```
public static <T> Result<T> serviceUnavailable(T data)
```
    服务不可用-503
    服务目前无法使用（由于超载或停机维护）
    
    Type Parameters:
    
    T - 泛型
    
    Parameters:
    
    data - 服务不可用的具体原因，参考：ResultPrompt.serviceUnavailable(int)
    
    Returns:
    
    HTTP请求，最外层响应对象
  - dataStructure
```
public static Result<?> dataStructure()
```
    数据结构异常-505
    
    Returns:
    
    HTTP请求，最外层响应对象
  - dataStructure
```
public static Result<?> dataStructure(int expected,
                                      int actual)
```
    数据结构异常-505
    不正确的结果大小
    
    Parameters:
    
    expected - 预期值
    
    actual - 实际值
    
    Returns:
    
    HTTP请求，最外层响应对象
  - dbError
```
public static Result<?> dbError()
```
    数据结构异常，请检查相应数据结构一致性-506
    
    Returns:
    
    HTTP请求，最外层响应对象
  - dbError
```
public static <T> Result<T> dbError(T data)
```
    数据结构异常，请检查相应数据结构一致性-506
    
    Parameters:
    
    data - Result#setData(Object) 提示信息
    
    Returns:
    
    HTTP请求，最外层响应对象
  - clientFallback
```
public static Result<?> clientFallback()
```
    哎哟喂！网络开小差了，请稍后重试...-507
    
    Returns:
    
    HTTP请求，最外层响应对象
  - clientFallback
```
public static <T> Result<T> clientFallback(T data)
```
    哎哟喂！网络开小差了，请稍后重试...-507
    
    Parameters:
    
    data - Result#setData(Object) 更详细的异常提示信息
    
    Returns:
    
    HTTP请求，最外层响应对象
  - clientFallbackError
```
public static Result<?> clientFallbackError()
```
    哎哟喂！服务都被您挤爆了...-508
    
    Returns:
    
    HTTP请求，最外层响应对象
  - clientFallbackError
```
public static <T> Result<T> clientFallbackError(T data)
```
    哎哟喂！服务都被您挤爆了...-508
    
    Parameters:
    
    data - Result#setData(Object) 更详细的异常提示信息
    
    Returns:
    
    HTTP请求，最外层响应对象
  - typeConvertError
```
public static <T> Result<T> typeConvertError(T data)
```
    类型转换错误-509
    
    Parameters:
    
    data - Result#setData(Object) 提示信息
    
    Returns:
    
    HTTP请求，最外层响应对象
  - errorPrompt
```
public static Result<?> errorPrompt(String msg)
```
    错误提示-600
    适用于用户操作提示、业务消息提示、友好的错误提示等场景。
    可优先使用 ResultPrompt 预定义的提示信息，如：ResultPrompt.USERNAME_OR_PASSWORD_ERROR
    
    Parameters:
    
    msg - 提示消息（如：）
    
    Returns:
    
    HTTP请求，最外层响应对象
  - errorPromptFormat
```
public static Result<?> errorPromptFormat(String msg,
                                          Object... values)
```
    错误提示-600
    适用于用户操作提示、业务消息提示、友好的错误提示等场景。
    可优先使用 ResultPrompt 预定义的提示信息，如：ResultPrompt.USERNAME_OR_PASSWORD_ERROR
    msg支持文本模板格式化，{} 表示占位符
```
例：("this is {} for {}", "a", "b") = this is a for b
```
    Parameters:
    
    msg - 文本模板，被替换的部分用 {} 表示
    
    values - 文本模板中占位符被替换的值
    
    Returns:
    
    HTTP请求，最外层响应对象
  - errorPrompt
```
public static <T> Result<T> errorPrompt(String msg,
                                        T data)
```
    错误提示-600
    适用于用户操作提示、业务消息提示、友好的错误提示等场景。
    可优先使用 ResultPrompt 预定义的提示信息，如：ResultPrompt.USERNAME_OR_PASSWORD_ERROR
    
    Parameters:
    
    msg - 提示消息（如：）
    
    data - 业务处理数据
    
    Returns:
    
    HTTP请求，最外层响应对象
  - getResult
```
public static Result<?> getResult(Throwable e)
```

Class R

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

R

Method Detail

success

success

success

success

loggedIn

resourceAlreadyInvalid

movedPermanently

fileEmpty

unauthorized

attack

attack

forbidden

notFound

methodNotAllowed

gone

tooManyRequests

paramVoid

paramCheckNotPass

paramCheckNotPass

paramValueInvalid

paramValueInvalid

paramDecryptError

internalServerError

internalServerError

requestError

requestError

serviceUnavailable

serviceUnavailable

serviceUnavailable

dataStructure

dataStructure

dbError

dbError

clientFallback

clientFallback

clientFallbackError

clientFallbackError

typeConvertError

errorPrompt

errorPromptFormat

errorPrompt

getResult