检测作为参数传递的对象的变化值

发布于 2024-07-14 00:55:36 字数 258 浏览 14 评论 0原文

我现在正在使用看起来像这样的代码，

public String getName(User user) {
     user.setSth(...);
     return user.getName();
}

我认为更改作为参数传递的对象是不好的做法。有没有一种工具可以检测这种代码？我查看了 findbugs、pmd 和 checkstyle，但找不到任何对此的检查。

PS 抱歉举了个不好的例子。

原文

I'm now working with code that looks like this

public String getName(User user) {
     user.setSth(...);
     return user.getName();
}

I think it's bad practice to change objects passed as parameters. Is there a tool that detects that kind of code? I looked at findbugs, pmd and checkstyle, but could not find any check for this.

P.S. sorry for bad example.

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

七七 2024-07-21 00:55:36

我认为您已经走在正确的道路上：检测此类代码的最佳工具几乎肯定是 Findbugs 。但是，您可能需要为此模式编写自己的检测器。这里是一个如何编写检测器的示例，尽管它不是不正是您正在寻找的探测器。

警告：我不太同意副作用吸气剂总是不好的风格。然而，如果你真的想找到这类东西，我会推荐 Findbugs。

回复收藏 0 原文

空宴 2024-07-21 00:55:36

您将找不到任何内容，因为从工具的角度来看，“getName”和“setSth”只是方法调用。人类说“这是一个 getter”和“这是一个 setter”，但工具却不会。事实上，getName() 不是 getter，因为 getter 不接受参数。

因此该工具看不到任何异常情况，因为方法一直在更改对象。

如果您想强制执行此规则，请查看扩展 findbugs 和 PMD。两者都允许您定义额外的约束。您正在寻找的可能是：

如果方法名称以“get”开头
并且方法主体调用任何对象的方法作为参数传递，

则打印警告。这应该不会花太长时间。运行这个，您将看到有多少“误报”（关于实际上没问题的方法的警告）。这将帮助您确定是否值得进一步追求这一点。另外，您还将有一个新项目添加到您的简历中:)

回复收藏 0 原文

但可醉心 2024-07-21 00:55:36

您可以使 User 不可变（声明它 final，声明所有属性 final 并远程设置器。我知道这在任何地方都不可行，但在很多地方都很好，将其传递给其他函数不会有任何问题）。

如果您必须“更改”某些内容，您可以在该示例中实现诸如 newId 之类的函数：

public final class User {
    private final String name;
    private final int id;

    User(String name, int id) {
        this.name = name;
        this.id = id;
    }

    public User newId(int newId) {
        return new User(this.name, newId);
    }

    //getters here;
}

内置的 String、Integer、...课程也能做到这一点。

You could make User immutable (declare it final, declare all properties final and remote the setters. I know that isn't practible everywhere but in many places that is good and you will have no problems in passing that to other functions).

If you have to "change" something, you can implement functions like newId in that sample:

public final class User {
    private final String name;
    private final int id;

    User(String name, int id) {
        this.name = name;
        this.id = id;
    }

    public User newId(int newId) {
        return new User(this.name, newId);
    }

    //getters here;
}

The built in String, Integer, ... classes do that, too.

回复收藏 0 原文

莫多说 2024-07-21 00:55:36

您可以创建一个名为 UserView 的接口，仅包含“getters”，让 User 实现它并使用新的 UserView 接口作为参数类型。

interface UserView{
 public String getName();
...

class User implements UserView...

public String getName(UserView user) {
     user.setSth(...); // Will not compile
     return user.getName();
}

You can create an interface called UserView containing only "getters", make User implement it and use the new UserView interface as the type of parameter.

interface UserView{
 public String getName();
...

class User implements UserView...

public String getName(UserView user) {
     user.setSth(...); // Will not compile
     return user.getName();
}

回复收藏 0 原文