【死磕Sharding-jdbc】---异常处理

一般项目都会有自己的一套异常处理方式,sharding-jdbc也不以外,sharding-jdbc源码处理异常的方式主要有下面2种方式:

  1. Preconditions
  2. 自定义异常

1. Preconditions

google-guava的Preconditions用于条件检查,不符合预期的话则抛出异常,并可以重写异常信息。google-guava源码中Preconditions的注释如下:

Static convenience methods that help a method or constructor check whether it was invoked correctly (whether its preconditions have been met). These methods generally accept a boolean expression which is expected to be true (or in the case of checkNotNull, an object reference which is expected to be non-null). When false (or null) is passed instead, the Preconditions method throws an unchecked exception, which helps the calling method communicate to its caller that that caller has made a mistake. 即帮助我们检查方法或者构造函数是否被正确调用,一般接收布尔表达式,期望布尔表达式的值为true;如果布尔表达式的值为false,就会抛出异常,让调用者知道错误的原因。

其部分static方法实现源码如下:

  • 检查参数是否正确--expression就是判断方法的参数的表达式,errorMessage是自定义异常,不允许为空;
// Ensures the truth of an expression involving one or more parameters to the calling method.public static void checkArgument(boolean expression, @Nullable Object errorMessage) {    if (!expression) {        throw new IllegalArgumentException(String.valueOf(errorMessage));    }}
  • 检查状态是否正确--expression就是判断状态的参数的表达式,errorMessage是自定义异常,不允许为空;
// Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.public static void checkState(boolean expression, @Nullable Object errorMessage) {    if (!expression) {        throw new IllegalStateException(String.valueOf(errorMessage));    }}
  • 检查不允许为空--reference就是待检查参数,errorMessage是自定义异常,不允许为空;
// Ensures that an object reference passed as a parameter to the calling method is not null.public static <T> T checkNotNull(T reference, @Nullable Object errorMessage) {    if (reference == null) {        throw new NullPointerException(String.valueOf(errorMessage));    }    return reference;}
  • 检查下标是否越界--index就是待检查下标参数,size就是集合的size,errorMessage是自定义异常,不允许为空;
/** * Ensures that {@code index} specifies a valid <i>element</i> in an array, list or string of size * {@code size}. An element index may range from zero, inclusive, to {@code size}, exclusive. */public static int checkElementIndex(        int index, int size, @Nullable String desc) {    // Carefully optimized for execution by hotspot (explanatory comment above)    if (index < 0 || index >= size) {        throw new IndexOutOfBoundsException(badElementIndex(index, size, desc));    }    return index;}

接下来我们看一下sharding-jdbc源码里张亮大神是如何使用Preconditions的:

  1. Preconditions.checkArgument()的使用 源码如下:
@SuppressWarnings("unchecked")private <T extends ShardingStrategy> T buildShardingAlgorithmClassName(final List<String> shardingColumns, ... ...) {    ... ...    // 如果是SingleKeyShardingAlgorithm,那么sharding column只能有一个    if (shardingAlgorithm instanceof SingleKeyShardingAlgorithm) {        Preconditions.checkArgument(1 == shardingColumns.size(), "Sharding-JDBC: SingleKeyShardingAlgorithm must have only ONE sharding column");        ... ...    }    ... ...}
  1. Preconditions.checkState()的使用 源码如下:
private Collection<String> routeDataSources(final TableRule tableRule) {    ... ...    Collection<String> result = strategy.doStaticSharding(tableRule.getActualDatasourceNames(), shardingValues);    // result是路由结果,即原生SQL路由后需要在哪些数据库中执行,很明显result肯定不可能为空;    Preconditions.checkState(!result.isEmpty(), "no database route info");    return result;}
  1. Preconditions.checkElementIndex()的使用 源码如下(不是来自sharding-jdbc源码中,而是笔者写的):
private static String getFromList(int index){    // 如果从集合中取数据, 首先校验下标    Preconditions.checkElementIndex(index, list.size(), "index is too big, list size is "+list.size()+". ");    return list.get(index);}

总结:很明显,借助google_guava的Preconditions能够让我们的代码更优雅,更简洁;

2. 自定义异常

sharding-jdbc自定义了异常处理类 ShardingJdbcException

public class ShardingJdbcException extends RuntimeException {    // 异常类构造方法:异常信息errorMessage中有多个参数,例如:throw new ShardingJdbcException("Unsupported Date type:%s", convertType);    public ShardingJdbcException(final String errorMessage, final Object... args) {        super(String.format(errorMessage, args));    }    // 把catch的异常转成ShardingJdbcException类型的异常,并重写异常信息    public ShardingJdbcException(final String message, final Exception cause) {        super(message, cause);    }    // 把异常转成ShardingJdbcException类型的异常,不重写异常信息    public ShardingJdbcException(final Exception cause) {        super(cause);    }}

sharding-jdbc中抛出自定义日志场景

-- 抛出自定义异常并重写有参数的异常信息

if (result.isEmpty()) {    throw new ShardingJdbcException("Cannot find table rule and default data source with logic tables: '%s'", logicTables);}
  • 将IllegalAccessException或者InvocationTargetException类型的异常转化为ShardingJdbcException异常,并重写异常信息为"Invoke jdbc method exception"
try {    method.invoke(target, arguments);} catch (final IllegalAccessException | InvocationTargetException ex) {    throw new ShardingJdbcException("Invoke jdbc method exception", ex);}
  • 把异常转成ShardingJdbcException类型的异常,不重写异常信息
public static void handleException(final Exception exception) {    if (isExceptionThrown()) {        throw new ShardingJdbcException(exception);    }    log.error("exception occur: ", exception);}

总结

sharding-jdbc对异常的处理还是很有参考价值的,自定义异常类型封装业务异常,我们一般都会这么做;但是如果能借鉴sharding-jdbc的源码,再增加对 Preconditions的使用,很明显能够让代码的逼格提升不少^^; ```

END

原文发布于微信公众号 - Java技术驿站(chenssy89)

原文发表时间:2018-07-12

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏杂烩

使用javascript让项目支持热插拔 原

    突然想起之前做过的一个小项目,项目虽小,需求却不小,要求解析特定格式的字符串,并且特定格式并非一成不变,想要一套系统能够支持解析多变的规则且更改规则时不...

1782
来自专栏JAVA后端开发

xml与java对象的快速互转

做流程图的项目时,新的流程定义为xml的,需要对xml与java对象进行互转 查了一下activiti的转换xml方式,发现转换太麻烦了,需要一步步的解析xm...

1.6K3
来自专栏云霄雨霁

Java--类和对象之初始化和清除

2025
来自专栏java 成神之路

Java中的四种引用类型

36012
来自专栏Ryan Miao

Java中ArrayList remove会遇到的坑

前言 平时最常用的莫过于ArrayList和HashMap了,面试的时候也是问答的常客。先不去管容量、负载因子什么的,就是简单的使用也会遇到坑。 ? Rem...

2837
来自专栏函数式编程语言及工具

Scalaz(57)- scalaz-stream: fs2-多线程编程,fs2 concurrency

    fs2的多线程编程模式不但提供了无阻碍I/O(java nio)能力,更为并行运算提供了良好的编程工具。在进入并行运算讨论前我们先示范一下fs2 pip...

2086
来自专栏机器学习与自然语言处理

04-树6. Huffman Codes--优先队列(堆)在哈夫曼树与哈夫曼编码上的应用

题目来源:http://www.patest.cn/contests/mooc-ds/04-%E6%A0%916 In 1953, David A. Huffm...

2857
来自专栏java初学

java异常处理及自定义异常的使用

1387
来自专栏菩提树下的杨过

Flash/Flex学习笔记(8):ActionScript3.0中的面对对象

首先要习惯AS3.0的几个BT约定: 1.一个.as文件中,只能定义一个类 2.类名称必须与.as的文件名相同 3.类定义中必须要有package包声明 4.一...

1849
来自专栏移动开发面面观

Java学习笔记——对象的生死

1234

扫码关注云+社区

领取腾讯云代金券