houyi平台-开发指南-服务层开发

服务定义与开发

定义服务接口

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);
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270

推荐阅读更多精彩内容

  • spring官方文档:http://docs.spring.io/spring/docs/current/spri...
    牛马风情阅读 1,580评论 0 3
  • 1、Spring Web MVC 与Spring Bean 注解 1-1、Spring Web MVC 注解 1-...
    初心myp阅读 1,633评论 3 34
  • PS: 本文讲得比较细,所以篇幅较长。 阅读时间:30m~1h。请认真读完,希望你一小时后能对统一异常处理有一个清...
    sprainkle阅读 19,078评论 21 157
  • 无 题 (一) 其实 我的心是痛的 此生许多事 流脓 结疤 我不语 像一棵没知觉的树...
    刘小柯阅读 606评论 9 13
  • 算起来,我与体内的毒瘤抗争已有十年之久,到了现在,它终于以它本来的面目在我身上凸现。今天走在路上,于是突然间觉得自...
    过河之马阅读 166评论 0 0