疯狂

STANDING ON THE SHOULDERS OF GIANTS
posts - 481, comments - 486, trackbacks - 0, articles - 1
  BlogJava :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理

我是如何写Service的

Posted on 2010-10-01 17:08 疯狂 阅读(894) 评论(0)  编辑  收藏 所属分类: java


文章转载自:http://kiral.javaeye.com/blog/606348?page=2#comments 原文还包括精彩的讨论。
马上要告别研发了,所以写一些自己积累的经验,用来纪念4年的似水流年,本篇为第一张,用来介绍自己是如何写Service的,当然我总结的不一定合理,大家一起讨论下。

 

笔者认为,Service及服务层,服务可以分为功能服务和业务服务,功能服务不易改变,业务服务易改变。所以功能服务添加得多,修改的少,那么我们可以考虑不使用接口。而业务服务,修改和更新都很频繁,所以应该提取接口,用不同的实现来屏蔽业务逻辑。

 

1:使用断言控制输入。

使用断言来判断有效的输入,这样能够避免异常的扩散,迅速定位错误和减少BUG出现的几率。

如:

Java代码 复制代码
  1. import org.springframework.util.Assert;  
Java代码 复制代码
  1. private boolean addAttachment(Attachment att) {   
  2.   Assert.notNull(att, "att对象不能为空");   
  3. }  

要学会灵活运用断言,不仅仅是用来断言来判断方法的输入参数是否正确,还可以判断业务逻辑,每次方法调用的输入输出,至于何时使用需要自己根据方法自我判断。

 

2:只抛出RumtimeException

作为service层,自己不清楚调用方到底是谁,也不知道调用方如何使用自己的接口,那么自己写出的接口最好是抛出RumtimeException,这样调用方能够处理这个异常或者觉得处理这个异常有必要的话,就进行处理。如果使用Exception就得强制那些处理不了的调用方继续向外抛出。抛出RumtimeException的时候需要在注释里申明我抛出了该异常。

Java代码 复制代码
  1. throw new RuntimeException("工作流初始化失败!");  

 

3:在Service层做事务处理

大家都知道Service层一般是用来组合DAO,所以经常出现需要事务处理的地方,笔者建议尽量在service层做事务处理。

因为一般业务逻辑都屏蔽在service层。笔者习惯使用Spring的手动事务。

Java代码 复制代码
  1. new TransactionTemplate(transactionManager).execute(new TransactionCallbackWithoutResult() {      
  2.             protected void doInTransactionWithoutResult(TransactionStatus status) {      
  3.                 //调用DAO按照ID删除部门      
  4.             }      
  5. });     

 

 

4:Service接口的异常处理

对于程序异常,service能够处理的自己处理(将异常封装成自己的异常,再向外抛出也算一种处理),不能处理的继续向外抛出。

对于业务异常,以前开发的时候都会向外抛出一个用户友好的运行时异常,这种异常信息是能够直接展现给用户的,如“您添加的用户名已经存在!”,但是现在考虑到国际化,所以觉得Service的接口应该抛出错误代码,定义一个友好错误代码运行时异常,在程序出现条件错误的时候抛出错误代码。错误代码可以定义一个枚举类来实现。

Java代码 复制代码
  1. /**  
  2.  * 错误代码定义  
  3.  *  
  4.  * @author fangtengfei  
  5.  * @date   2010-3-3  
  6.  */  
  7. public enum ErrorCode {   
  8.     /**  
  9.      * 用户不能重复  
  10.      */  
  11.     User_Not_Repeat,   
  12.     /**  
  13.      * 用户名太长  
  14.      */  
  15.     User_Name_Too_Long   
  16. }  
Java代码 复制代码
  1. 在Service里抛出:throw new FriendlyCodeRuntimeException(ErrorCode.User_Not_Repeat.toString());  

  

 

5:必须记录日志

  大家都知道,记录日志的目的,主要是当程序运行在不同的环境下,使用日志来监控程序的运行,有些异常可能会特定的环境发生,而这种环境不容易被重现,所以此时唯一能定位问题的途径就只有日志。

Service层会被各种调用方使用,特别是对外提供Service,环境更会前差万别,如何迅速并有效的定位错误变得尤其重要,所以必须记录有效的日志。

Java代码 复制代码
  1. logger.error("更新文档出现出错", e);  

 

 6:写有效的注释

之所以说写有效的注释,是因为有时候,有些方法真的不需要写注释,如addUser,就不要在写注释“添加用户”这样的注释。关键是写有效的注释,注释的作用在于,调用方只看注释而不看代码就能知道如何使用接口,注释应该包括:输入参数的注释,输出参数的注释和异常的注释。特别是List<Map>,Sting[]这样的参数要严格说明,笔者认为Service作为一个核心层,注释必须非常详细。另外直观的方法名也能起到注释的作用。

Java代码 复制代码
  1. /**  
  2. * 批量添加文档的附件   
  3.  
  4. * @param att 附件对象,附件名长度为20,附件大小为10M  
  5. * @throws FriendlyCodeRuntimeException  
  6.  */  
  7. private void addAttachment(Attachment... attachment)  

只有注册用户登录后才能发表评论。


网站导航: