服务定义与开发

定义服务接口

package com.houyi.user.service;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.houyi.common.service.ISuperService;
import com.houyi.user.model.SysUserExcel;
import com.houyi.common.model.PageResult;
import com.houyi.common.model.Result;
import com.houyi.common.model.LoginAppUser;
import com.houyi.common.model.SysRole;
import com.houyi.common.model.SysUser;
/**
* @Author: houyi
 */
public interface ISysUserService extends ISuperService<SysUser> {
    /**
     * 获取UserDetails对象
     * @param username
     * @return
     */
    LoginAppUser findByUsername(String username);
    ... 
    ...
    ...
}

新建services实现层类SysUserServiceImpl:

package com.houyi.user.service.impl;
@Slf4j
@Service
public class SysUserServiceImpl extends SuperServiceImpl<SysUserMapper, SysUser> implements ISysUserService {
    private final static String LOCK_KEY_USERNAME = CommonConstant.LOCK_KEY_PREFIX+"username:";
    @Override
    public LoginAppUser findByUsername(String username) {
        SysUser sysUser = this.selectByUsername(username);
        return getLoginAppUser(sysUser);
    }
    ...
    ...
    ...
}

SuperServiceImpl （common-spring-boot-starter -> com.houyi.common.service.impl） service实现父类实现了通用方法

package com.houyi.common.service.impl;
/**
 * service实现父类
 *
 * @Author: houyi
 * @date 2019/1/10
 */
public class SuperServiceImpl<M extends BaseMapper<T>, T> extends ServiceImpl<M, T> implements ISuperService<T> {
    ...
    ...
    ...
}

---

事物管理

为保证业务执行的完整性，需要使用事务。Spring为我们集成了完整的事物功能。通过简单的注解就能实现对事物的支持

事务的启用

在应用入口类添加@EnableTransactionManagement注解即可在项目中启用声明式事务。

@EnableLoginArgResolver
@EnableDiscoveryClient
@EnableFeignClients
@EnableTransactionManagement
@SpringBootApplication
public class UserCenterApp {
    public static void main(String[] args) {
        ConfigurableApplicationContext applicationContext = SpringApplication.run(UserCenterApp.class, args);
    }

事务的使用

(1)在Service类添加@Transactional即可使得该类所有方法自动添加事务支持

@Slf4j
@Service
@Transactional
public class SysUserServiceImpl extends SuperServiceImpl<SysUserMapper, SysUser> implements ISysUserService {
    private final static String LOCK_KEY_USERNAME = CommonConstant.LOCK_KEY_PREFIX+"username:";
}

(2)在方法上使用@Transactional

   @Transactional(rollbackFor = Exception.class)
    @Override
    public void saveRole(SysRole sysRole) {
        String roleCode = sysRole.getCode();
        super.saveIdempotency(sysRole, lock
                , LOCK_KEY_ROLECODE+roleCode, new QueryWrapper<SysRole>().eq("code", roleCode), "角色code已存在");
    }

---

业务异常开发指南

为了解决Controller层接收到Service层各种各样业务异常，传统try-catch方法代码冗余。
平台使用@ControllerAdvice + @ExceptionHandler 进行全局的 Controller 层异常处理。
将Controller层的异常和数据校验的异常进行统一处理，提升扩展性和可维护性，但是只能处理 Controller 层未捕获（往外抛）的异常。

公共模块说明

公共模块封装：common-spring-boot-starter项目下com.houyi.common.exception封装了业务异常公共处理。各个微服务继承DefaultExceptionAdvice进行异常捕获。

通用业务异常示例：

public class BusinessException extends RuntimeException {
    private static final long serialVersionUID = 6610083281801529147L;
    public BusinessException(String message) {
        super(message);
    }
}

DefaultExceptionAdvice进行一些通用异常捕获(@ExceptionHandler 注解声明异常处理方法)：

@ResponseBody
@Slf4j
public class DefaultExceptionAdvice {
    /**
     * BusinessException 业务异常处理
     * 返回状态码:500
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(BusinessException.class)
    public Result handleException(BusinessException e) {
        return defHandler("业务异常", e);
    }
    /**
     * Exception 及其子类的异常 统一处理
     * 返回状态码:500
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(Exception.class)
    public Result handleException(Exception e) {
        return defHandler("未知异常", e);
    }
    private Result defHandler(String msg, Exception e) {
        log.error(msg, e);
        return Result.failed(msg);
    }
}

DefaultExceptionAdvice可封装统一的状态码，错误提示信息。若有各模块通用的异常类可在com.houyi.common.exception包下添加后，注册在DefaultExceptionAdvice。

子模块使用

@ControllerAdvice 注解定义全局异常处理类
可根据子模块业务情况添加@ExceptionHandler 异常处理方法

 @ControllerAdvice
public class ExceptionAdvice extends DefaultExceptionAdvice {
    /**
     * BusinessException 业务异常处理
     * 返回状态码:500
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(BusinessException.class)
    public Result handleException(BusinessException e) {
        return defHandler("名字错误", e);
    }
}