feltdrunk

Yarn

Quick note about Yarn. YARN #1.安装 E:\front-end>npm i -g yarn #2.查看配置 E:\front-end>yarn config list yarn config v1.22.15 info yarn config { 'version-tag-prefix': 'v', 'version-git-tag': true, 'version-commit-hooks': true, 'version-git-sign': false, 'version-git-message': 'v%s', 'init-version': '1.0.0', 'init-license': 'MIT', 'save-prefix': '^', 'bin-links': true, 'ignore-scripts': false, 'ignore-optional': false, registry: 'https://registry.yarnpkg.com', 'strict-ssl': true, 'user-agent': 'yarn/1.22.15 npm/? node/v14.16.1 win32 x64' } info npm config { home: 'https://npm.taobao.org', registry: 'https://registry.npm.taobao.org/' } #3.换源 E:\front-end>yarn config set registry https://registry.npm.taobao.org yarn config v1.22.15 success Set "registry" to "https://registry.npm.taobao.org". Done in 0.07s. #4.常用命令初始化项目: yarn init // 同npm init，执行输入信息后，会生成package.json文件 yarn的配置项： yarn config list // 显示所有配置项 yarn config get <key> //显示某配置项 yarn config delete <key> //删除某配置项 yarn config set <key> <value> [-g|--global] //设置配置项安装包： yarn install //安装package.json里所有包，并将包及它的所有依赖项保存进yarn.lock yarn install --flat //安装一个包的单一版本 yarn install --force //强制重新下载所有包 yarn install --production //只安装dependencies里的包 yarn install --no-lockfile //不读取或生成yarn.lock yarn install --pure-lockfile //不生成yarn.lock 添加包（会更新package.json和yarn.lock）： yarn add [package] // 在当前的项目中添加一个依赖包，会自动更新到package.json和yarn.lock文件中 yarn add [package]@[version] // 安装指定版本，这里指的是主要版本，如果需要精确到小版本，使用-E参数 yarn add [package]@[tag] // 安装某个tag（比如beta,next或者latest） //不指定依赖类型默认安装到dependencies里，你也可以指定依赖类型： yarn add --dev/-D // 加到 devDependencies yarn add --peer/-P // 加到 peerDependencies yarn add --optional/-O // 加到 optionalDependencies //默认安装包的主要版本里的最新版本，下面两个命令可以指定版本： yarn add --exact/-E // 安装包的精确版本。例如yarn add foo@1.2.3会接受1.9.1版，但是yarn add foo@1.2.3 --exact只会接受1.2.3版 yarn add --tilde/-T // 安装包的次要版本里的最新版。例如yarn add foo@1.2.3 --tilde会接受1.2.9，但不接受1.3.0 发布包 yarn publish 移除一个包 yarn remove <packageName>：移除一个包，会自动更新package.json和yarn.lock 更新一个依赖 yarn upgrade 用于更新包到基于规范范围的最新版本运行脚本 yarn run 用来执行在 package.json 中 scripts 属性下定义的脚本显示某个包的信息 yarn info <packageName> 可以用来查看某个模块的最新版本信息缓存 yarn cache yarn cache list # 列出已缓存的每个包 yarn cache dir # 返回全局缓存位置 yarn cache clean # 清除缓存 #npm与yarn npm init === yarn init npm install === yarn 或者 yarn install npm install taco --save === yarn add taco npm uninstall taco --save === yarn remove taco npm install taco --save-dev === yarn add taco --dev npm update --save === yarn upgrade npm install taco@latest --save === yarn add taco npm install taco --global === yarn global add taco npm init --yes/-y === yarn init --yes/-y npm link === yarn link npm outdated === yarn outdated npm publish === yarn publish npm run === yarn run npm cache clean === yarn cache clean npm login === yarn login npm test === yarn test

2021/10/09

Java API Validation

Quick note about Java API Validation. JAVA API Validation 1.组成接口地址 url 接口请求方式（get，post，put等）请求数据（request）响应数据（response） 2.参数校验对参数（请求数据）进行安全校验在业务层进行校验 public String addUser(User user) { if (user == null || user.getId() == null || user.getAccount() == null || user.getPassword() == null || user.getEmail() == null) { return "对象或者对象字段不能为空"; } if (StringUtils.isEmpty(user.getAccount()) || StringUtils.isEmpty(user.getPassword()) || StringUtils.isEmpty(user.getEmail())) { return "不能输入空字符串"; } if (user.getAccount().length() < 6 || user.getAccount().length() > 11) { return "账号长度必须是6-11个字符"; } if (user.getPassword().length() < 6 || user.getPassword().length() > 16) { return "密码长度必须是6-16个字符"; } if (!Pattern.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$", user.getEmail())) { return "邮箱格式不正确"; } // 参数校验完毕后这里就写上业务逻辑 return "success"; } Validator + BindResult进行校验 //简化代码，使用方便，减少耦合度，业务层只关注业务逻辑，从基本的参数校验逻辑中脱离。 @Data public class User { @NotNull(message = "用户id不能为空") private Long id; @NotNull(message = "用户账号不能为空") @Size(min = 6, max = 11, message = "账号长度必须是6-11个字符") private String account; @NotNull(message = "用户密码不能为空") @Size(min = 6, max = 11, message = "密码长度必须是6-16个字符") private String password; @NotNull(message = "用户邮箱不能为空") @Email(message = "邮箱格式不正确") private String email; } @RestController @RequestMapping("user") public class UserController { @Autowired private UserService userService; @PostMapping("/addUser") public String addUser(@RequestBody @Valid User user, BindingResult bindingResult) { // 如果有参数校验失败，会将错误信息封装成对象组装在BindingResult里 for (ObjectError error : bindingResult.getAllErrors()) { return error.getDefaultMessage(); } return userService.addUser(user); } } public String addUser(User user) { // 直接编写业务逻辑 return "success"; } Validator + 自动抛出异常 //只需要在入参的成员变量上加上Validator校验规则注解，然后在参数上加上@Valid注解即可完成校验，但这样会直接将错误对象相关信息都响应给前端，需要引入全局异常处理。 @PostMapping("/addUser") public String addUser(@RequestBody @Valid User user) { return userService.addUser(user); } 3.全局异常处理不想手动捕获异常，又要对这个异常进行处理。新建一个类，在这个类上加上@ControllerAdvice或@RestControllerAdvice注解，这个类就配置成全局处理类了。（这个根据你的Controller层用的是@Controller还是@RestController来决定）然后在类中新建方法，在方法上加上@ExceptionHandler注解并指定你想处理的异常类型，接着在方法内编写对该异常的操作逻辑，就完成了对该异常的全局处理！ @RestControllerAdvice public class ExceptionControllerAdvice { @ExceptionHandler(MethodArgumentNotValidException.class) public String MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) { // 从异常对象中拿到ObjectError对象 ObjectError objectError = e.getBindingResult().getAllErrors().get(0); // 然后提取错误提示信息进行返回 return objectError.getDefaultMessage(); } } 4.自定义异常全局处理当然不会只能处理一种异常，用途也不仅仅是对一个参数校验方式进行优化。在实际开发中，如何对异常处理其实是一个很麻烦的事情。传统处理异常一般有以下烦恼：是捕获异常(try...catch)还是抛出异常(throws) 是在controller层做处理还是在service层处理又或是在dao层做处理处理异常的方式是啥也不做，还是返回特定数据，如果返回又返回什么数据不是所有异常我们都能预先进行捕捉，如果发生了没有捕捉到的异常该怎么办？以上这些问题都可以用全局异常处理来解决，全局异常处理也叫统一异常处理，全局和统一处理代表什么？代表规范！规范有了，很多问题就会迎刃而解！全局异常处理的基本使用方式大家都已经知道了，我们接下来更进一步的规范项目中的异常处理方式：自定义异常。在很多情况下，我们需要手动抛出异常，比如在业务层当有些条件并不符合业务逻辑，我这时候就可以手动抛出异常从而触发事务回滚。那手动抛出异常最简单的方式就是throw new RuntimeException("异常信息")了，不过使用自定义会更好一些：自定义异常可以携带更多的信息，不像这样只能携带一个字符串。项目开发中经常是很多人负责不同的模块，使用自定义异常可以统一了对外异常展示的方式。自定义异常语义更加清晰明了，一看就知道是项目中手动抛出的异常。 Getter //只要getter方法，无需setter public class APIException extends RuntimeException { private int code; private String msg; public APIException() { this(1001, "接口错误"); } public APIException(String msg) { this(1001, msg); } public APIException(int code, String msg) { super(msg); this.code = code; this.msg = msg; } } @ExceptionHandler(APIException.class) public String APIExceptionHandler(APIException e) { return e.getMsg(); } 这样就对异常的处理就比较规范了，当然还可以添加对Exception的处理，这样无论发生什么异常我们都能屏蔽掉然后响应数据给前端，不过建议最后项目上线时这样做，能够屏蔽掉错误信息暴露给前端，在开发中为了方便调试还是不要这样做。现在全局异常处理和自定义异常已经弄好了，不知道大家有没有发现一个问题，就是当我们抛出自定义异常的时候全局异常处理只响应了异常中的错误信息msg给前端，并没有将错误代码code返回。这就要引申出我们接下来要讲的东西了：数据统一响应 5.数据统一响应现在我们规范好了参数校验方式和异常处理方式，然而还没有规范响应数据！比如我要获取一个分页信息数据，获取成功了呢自然就返回的数据列表，获取失败了后台就会响应异常信息，即一个字符串，就是说前端开发者压根就不知道后端响应过来的数据会是啥样的！所以，统一响应数据是前后端规范中必须要做的！自定义统一响应体统一数据响应第一步肯定要做的就是我们自己自定义一个响应体类，无论后台是运行正常还是发生异常，响应给前端的数据格式是不变的！那么如何定义响应体呢？可以参考我们自定义异常类，也来一个响应信息代码code和响应信息说明msg： @Getter public class ResultVO<T> { /** * 状态码，比如1000代表响应成功 */ private int code; /** * 响应信息，用来说明响应情况 */ private String msg; /** * 响应的具体数据 */ private T data; public ResultVO(T data) { this(1000, "success", data); } public ResultVO(int code, String msg, T data) { this.code = code; this.msg = msg; this.data = data; } } 然后我们修改一下全局异常处理那的返回值： @ExceptionHandler(APIException.class) public ResultVO<String> APIExceptionHandler(APIException e) { // 注意哦，这里返回类型是自定义响应体 return new ResultVO<>(e.getCode(), "响应失败", e.getMsg()); } @ExceptionHandler(MethodArgumentNotValidException.class) public ResultVO<String> MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) { ObjectError objectError = e.getBindingResult().getAllErrors().get(0); // 注意哦，这里返回类型是自定义响应体 return new ResultVO<>(1001, "参数校验失败", objectError.getDefaultMessage()); } OK，这个异常信息响应就非常好了，状态码和响应说明还有错误提示数据都返给了前端，并且是所有异常都会返回相同的格式！异常这里搞定了，别忘了我们到接口那也要修改返回类型，我们新增一个接口好来看看效果： @GetMapping("/getUser") public ResultVO<User> getUser() { User user = new User(); user.setId(1L); user.setAccount("12345678"); user.setPassword("12345678"); user.setEmail("123@qq.com"); return new ResultVO<>(user); } 这样无论是正确响应还是发生异常，响应数据的格式都是统一的，十分规范！数据格式是规范了，不过响应码code和响应信息msg还没有规范呀！大家发现没有，无论是正确响应，还是异常响应，响应码和响应信息是想怎么设置就怎么设置，要是10个开发人员对同一个类型的响应写10个不同的响应码，那这个统一响应体的格式规范就毫无意义！所以，必须要将响应码和响应信息给规范起来。响应码枚举要规范响应体中的响应码和响应信息用枚举简直再恰当不过了，我们现在就来创建一个响应码枚举类： @Getter public enum ResultCode { SUCCESS(1000, "操作成功"), FAILED(1001, "响应失败"), VALIDATE_FAILED(1002, "参数校验失败"), ERROR(5000, "未知错误"); private int code; private String msg; ResultCode(int code, String msg) { this.code = code; this.msg = msg; } } 然后修改响应体的构造方法，让其只准接受响应码枚举来设置响应码和响应信息： public ResultVO(T data) { this(ResultCode.SUCCESS, data); } public ResultVO(ResultCode resultCode, T data) { this.code = resultCode.getCode(); this.msg = resultCode.getMsg(); this.data = data; } 然后同时修改全局异常处理的响应码设置方式： @ExceptionHandler(APIException.class) public ResultVO<String> APIExceptionHandler(APIException e) { // 注意哦，这里传递的响应码枚举 return new ResultVO<>(ResultCode.FAILED, e.getMsg()); } @ExceptionHandler(MethodArgumentNotValidException.class) public ResultVO<String> MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) { ObjectError objectError = e.getBindingResult().getAllErrors().get(0); // 注意哦，这里传递的响应码枚举 return new ResultVO<>(ResultCode.VALIDATE_FAILED, objectError.getDefaultMessage()); } 这样响应码和响应信息只能是枚举规定的那几个，就真正做到了响应数据格式、响应码和响应信息规范化、统一化！ 6.全局处理响应数据接口返回统一响应体 + 异常也返回统一响应体，其实这样已经很好了，但还是有可以优化的地方。要知道一个项目下来定义的接口搞个几百个太正常不过了，要是每一个接口返回数据时都要用响应体来包装一下好像有点麻烦，有没有办法省去这个包装过程呢？当然是有滴，还是要用到全局处理。首先，先创建一个类加上注解使其成为全局处理类。然后继承ResponseBodyAdvice接口重写其中的方法，即可对我们的controller进行增强操作，具体看代码和注释： @RestControllerAdvice(basePackages = {"com.stone.controller"}) // 注意哦，这里要加上需要扫描的包 public class ResponseControllerAdvice implements ResponseBodyAdvice<Object> { @Override public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> aClass) { // 如果接口返回的类型本身就是ResultVO那就没有必要进行额外的操作，返回false // TODO 其他条件 return !returnType.getParameterType().equals(ResultVO.class); } @Override public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest request, ServerHttpResponse response) { // String类型不能直接包装，所以要进行些特别的处理 if (returnType.getGenericParameterType().equals(String.class)) { ObjectMapper objectMapper = new ObjectMapper(); try { // 将数据包装在ResultVO里后，再转换为json字符串响应给前端 return objectMapper.writeValueAsString(new ResultVO<>(data)); } catch (JsonProcessingException e) { throw new APIException("返回String类型错误"); } } // 将原本的数据包装在ResultVO里 return new ResultVO<>(data); } } 重写的这两个方法是用来在controller将数据进行返回前进行增强操作，supports方法要返回为true才会执行beforeBodyWrite方法，所以如果有些情况不需要进行增强操作可以在supports方法里进行判断。对返回数据进行真正的操作还是在beforeBodyWrite方法中，我们可以直接在该方法里包装数据，这样就不需要每个接口都进行数据包装了，省去了很多麻烦。我们可以现在去掉接口的数据包装来看下效果： @GetMapping("/getUser") public User getUser() { User user = new User(); user.setId(1L); user.setAccount("12345678"); user.setPassword("12345678"); user.setEmail("123@qq.com"); // 这里是直接返回的User类型，并没有用ResultVO进行包装 return user; } 然后我们来看下响应数据： { "code": 1000, "msg": "操作成功", "data": { "id": 1, "account": "12345678", "password": "12345678", "email": "123@qq.com" } } 注：beforeBodyWrite方法里包装数据无法对String类型的数据直接进行强转 7.总结自此整个后端接口基本体系就构建完毕了通过Validator + 自动抛出异常来完成了方便的参数校验通过全局异常处理 + 自定义异常完成了异常操作的规范通过数据统一响应完成了响应数据的规范多个方面组装非常优雅的完成了后端接口的协调，让开发人员有更多的经历注重业务逻辑代码，轻松构建后端接口

2021/10/06

Stay Hungry,Stay Foolish

Yarn

Java API Validation

Java Naming Convention

First Spring Boot Application

Spring-Note01

Mybatis CRUD

Mybatis Configuration

MyBatis Architecture

MySQL Index

My Popular Repositories

springmvc-response

springclouddemo

hello-world