api中重载函数的原理

重载方法是API设计中的一个重要概念,尤其是当您的API是流利的API或DSL( 特定于域的语言 )时。

对于jOOQ就是这种情况,在这种情况下,您经常想使用与完全相同的方法名称来与库进行各种交互。






示例:jOOQ条件

package org.jooq;public interface Condition {// Various overloaded forms of the "AND" operation:Condition and(Condition other);Condition and(String sql);Condition and(String sql, Object... bindings);// [...]}

所有这些方法都使用“ AND”运算符将两个条件相互关联。 理想情况下,实现相互依赖,从而造成单点故障。 这会使事情变干 :

package org.jooq.impl;abstract class AbstractCondition implements Condition {// The single point of failure@Overridepublic final Condition and(Condition other) {return new CombinedCondition(Operator.AND, Arrays.asList(this, other));}// "Convenience methods" delegating to the other one@Overridepublic final Condition and(String sql) {return and(condition(sql));}@Overridepublic final Condition and(String sql, Object... bindings) {return and(condition(sql, bindings));}}

泛型和重载的麻烦

当使用Eclipse开发时,Java 5世界似乎比实际情况更加光彩照人。 Varargs和泛型在Java 5中作为语法糖引入。它们在JVM中并不是真的存在。 这意味着编译器必须正确链接方法调用,在需要时推断类型,并在某些情况下创建综合方法。 根据JLS( Java语言规范 ),当在重载方法中使用varargs / generics时,存在很多歧义。

让我们详细介绍一下泛型:

在jOOQ中要做的一件好事是将常量值与字段一样对待。 在许多地方,字段参数像这样重载:

// This is a convenience method:public static <T> Field<T> myFunction(Field<T> field, T value) {return myFunction(field, val(value));}// It's equivalent to this one.public static <T> Field<T> myFunction(Field<T> field, Field<T> value) {return MyFunction<T>(field, value);}

在大多数情况下,上面的方法效果很好。 您可以像这样使用上述API:

Field<Integer> field1  = //...Field<String>  field2  = //...Field<Integer> result1 = myFunction(field1, 1);Field<String>  result2 = myFunction(field2, "abc");

但是,当<T>绑定到对象时,就会出现麻烦!

// While this works...Field<Object>  field3  = //...Field<Object>  result3 = myFunction(field3, new Object());// ... this doesn't!Field<Object>  field4  = //...Field<Object>  result4 = myFunction(field4, field4);Field<Object>  result4 = myFunction(field4, (Field) field4);Field<Object>  result4 = myFunction(field4, (Field<Object>) field4);

当<T>绑定到Object时,两种方法突然都适用,并且根据JLS,它们都不是更具体的! 尽管Eclipse编译器通常比较宽容(并且在这种情况下直观地链接了第二个方法),但是javac编译器不知道该调用要做什么。 而且没有办法解决。 您不能将field4强制转换为Field或Field <Object>强制链接器链接至第二种方法。 对于API设计人员来说,这是个坏消息。

有关此特殊情况的更多详细信息,请考虑以下堆栈溢出问题,我将此问题报告给Oracle和Eclipse。 让我们看看哪种编译器实现是正确的:
http://stackoverflow.com/questions/5361513/reference-is-ambiguous-with-generics

静态导入的麻烦,varargs

Varargs是Java 5中引入的另一个重要功能。尽管它只是语法糖,但在将数组传递给方法时可以节省很多代码:

// Method declarations with or without varargspublic static String concat1(int[] values);public static String concat2(int... values);// The above methods are actually the same.String s1 = concat1(new int[] { 1, 2, 3 });String s2 = concat2(new int[] { 1, 2, 3 });// Only, concat2 can also be called like this, convenientlyString s3 = concat2(1, 2, 3);

那是众所周知的。 它与原始类型数组的工作方式与与Object []相同。 它也可以与T []一起使用,其中T是泛型类型!

// You can now have a generic type in your varargs parameter:public static <T> T[] array(T... values);// The above can be called "type-safely" (with auto-boxing):Integer[] ints   = array(1, 2, 3);String[] strings = array("1", "2", "3");// Since Object could also be inferred for T, you can even do this:Object[] applesAndOranges = array(1, "2", 3.0);

最后一个例子实际上已经暗示了这个问题。 如果T没有任何上限,则类型安全性完全消失。 这是一种错觉,因为最后,总是可以将varargs参数推断为“ Object…”。 这就是当您重载此类API时这会引起麻烦的方式。

// Overloaded for "convenience". Let's ignore the compiler warning// caused when calling the second methodpublic static <T> Field<T> myFunction(T... params);public static <T> Field<T> myFunction(Field<T>... params);

起初,这看起来是个好主意。 参数列表可以是常量值(T…)或动态字段(Field…)。 因此,原则上,您可以执行以下操作:

// The outer function can infer Integer for <T> from the inner// functions, which can infer Integer for <T> from T...Field<Integer> f1 = myFunction(myFunction(1), myFunction(2, 3));// But beware, this will compile too!Field<?> f2 = myFunction(myFunction(1), myFunction(2.0, 3.0));

内部函数将推断<T>的Integer和Double。 对于不兼容的返回类型Field <Integer>和Field <Double>,带有“ Field <T>…”参数的“打算”方法不再适用。 因此,编译器将带有“ T…”的方法一链接为唯一适用的方法。 但是您不会猜测<T>的(可能)推断范围。 这些是可能的推断类型:

// This one, you can always do:Field<?> f2 = myFunction(myFunction(1), myFunction(2.0, 3.0));// But these ones show what you're actually about to doField<? extends Field<?>>                       f3 = // ...Field<? extends Field<? extends Number>>        f4 = // ...Field<? extends Field<? extends Comparable<?>>> f5 = // ...Field<? extends Field<? extends Serializable>>  f6 = // ...

编译器可以推断出诸如Field <? 将Number&Comparable <?>和Serializable>扩展为<T>的有效上限。 但是,<T>没有有效的确切界限。 因此,必要的<? 扩展[上限]>。

结论

将varargs参数与泛型结合使用时要特别小心,尤其是在重载方法中。 如果用户将通用类型参数正确绑定到您想要的目标,则一切正常。 但是,如果有一个拼写错误(例如,将Integer与Double混淆),那么您的API用户就注定了。 而且他们不会轻易发现自己的错误,因为没有人能读懂这样的编译器错误消息:

Test.java:58: incompatible types
found   : Test.Field<Test.Field<? extends java.lang.Number&java.lang.Comparable<? extends java.lang.Number&java.lang.Comparable<?>>>>
required: Test.Field<java.lang.Integer>Field<Integer> f2 = myFunction(myFunction(1),myFunction(2.0, 3.0));

参考:在JAVA,SQL和JOOQ博客上,我们的JCG合作伙伴 Lukas Eder 谨慎使用了重载API方法 。

相关文章 :

  • Java中的数据库架构导航
  • ORM问题
  • Java泛型快速教程
  • 使用Spring和Java泛型简化数据访问层

翻译自: https://www.javacodegeeks.com/2011/12/overload-api-methods-with-care.html

api中重载函数的原理

api中重载函数的原理_小心重载API方法相关推荐

  1. 没有与参数列表匹配的 重载函数 getline 实例_面试题:方法重载的底层原理?...

    前语:微信改版后,大量读者还没养成点赞的习惯,如写得好,望大家阅读后在右下边"好看"处点个赞,以示鼓励!长期坚持原创真的很不容易,多次想放弃,坚持是一种信仰,专注是一种态度. 关于 ...

  2. matlab怎么画碎石图,成分分析中biplot函数不理解_主成分分析

    成分分析中biplot函数不理解_主成分分析 对主成分分析中的biplot函数不理解,谁能帮忙解释?谢谢了 解答: 运行下面的例子,理解我加黑的那句话即可: Examples Perform a pr ...

  3. C++中虚函数工作原理和(虚)继承类的内存占用大小计算

    转载请标明出处,原文地址:http://blog.csdn.net/hackbuteer1/article/details/7883531 一.虚函数的工作原理       虚函数的实现要求对象携带额 ...

  4. java js中 function函数报错_浅析JS中对函数function的理解(基础篇)

    正文:我们知道,在js中,函数实际上是一个对象,每个函数都是Function类型的实例,并且都与其他引用类型一样具有属性和方法.因此,函数名实际上是指向函数对象的指针,不与某个函数绑定.在常见的两种定 ...

  5. Matlab中mat2gray函数的原理和使用及图像类和类型间的转换

    mat2gray 函数mat2gray可以把任意任意类型图像矩阵转换为取值范围为[0,1]的归一化double类数组. 调用格式 B = mat2gray(A) 将图像矩阵A归一化为图像矩阵B,A的值 ...

  6. C++中虚函数工作原理

    转载请标明出处,原文地址:http://blog.csdn.net/hackbuteer1/article/details/7883531 一.虚函数的工作原理 虚函数的实现要求对象携带额外的信息,这 ...

  7. 关于python中lambda函数的描述_关于Python中的lambda函数

    lambda是Python编程语言中使用频率较高的一个关键字.那么,什么是lambda?它有哪些用法?网上的文章汗牛充栋,可是把这个讲透的文章却不多.这里,我们通过阅读各方资料,总结了关于Python ...

  8. python中complex函数的用法_​Python中complex函数有什么用

    ​Python中complex函数有什么用 发布时间:2020-12-15 09:34:36 来源:亿速云 阅读:71 作者:小新 这篇文章给大家分享的是有关Python中complex函数有什么用的 ...

  9. python如何调用dll库中的函数_Python调用dll库接口-ctypes方法

    背景 最近需要用python写个脚本程序(win10 环境),需要调用现成的dll库完成这项任务,对于一直在Linux平台上开发程序的本人来说,从没有过使用dll的经历(不得不说还是so大法好),遇到 ...

最新文章

  1. php登录半透明,WordPress透明OAuth 1.0使用PHP登录
  2. Spring IOC 容器源码分析 - 获取单例 bean
  3. flask mysql项目模板渲染_Flask框架模板渲染操作简单示例
  4. 前端学习(2459):账户设置
  5. stm32usb做虚拟串口和键盘_关于stm32f103的USB虚拟串口程序移植
  6. 不妨问问自己,学习C语言是为了什么?
  7. [USACO18OPEN]Talent Show
  8. python3.7读取csv文件_Python3 读取csv文件
  9. 雪球python爬虫炒股_如何使用 Python 抓取雪球网页?
  10. 21.08.01 cnvoron带你玩转Voron2.4
  11. md文件打开错误(Failed to load file)
  12. BigDL:分布式开放源码Apache SCAP深度学习库
  13. 图解Stm32使用jlink下载程序时jtag接口(SW和JTAG模式)的简化方法
  14. kd树搜索(k邻近法)
  15. 异地恋的自愈系小故事:企鹅先生和北极熊小姐
  16. 谷歌注册手机无法验证解决办法2023亲测有效非常迅速
  17. 五层协议网络体系结构的要点及主要任务
  18. Unity3d简单的发牌效果
  19. itext html to pdf设置边距,iText:设置边距是否有效?
  20. Kubenetes基础学习

热门文章

  1. hibernate正向生成数据库表以及配置——Student.hbm.xml
  2. JS中闭包的应用自定义JS模块2
  3. 用rollback()VS不用rollback()
  4. dismiss的词组_法律英语常用词必记:Dismiss
  5. MySQL的CRUD操作+使用视图
  6. 单列集合Set的实现类HashSet
  7. lombok_Lombok–您绝对应该尝试一下
  8. 枚举对象注释_如何以及何时使用枚举和注释
  9. gradle入门_Gradle入门:集成测试
  10. 虚拟机间延迟测量_简单的类来测量延迟