KW代码检查规则-RLK.JNDI

最新推荐文章于 2024-04-15 09:37:23 发布

NUAA_Hunter

最新推荐文章于 2024-04-15 09:37:23 发布

阅读量3.2k

点赞数

分类专栏： java 代码静态检查文章标签： KW代码检查规则

java 同时被 2 个专栏收录

6 篇文章 0 订阅

订阅专栏

代码静态检查

1 篇文章 0 订阅

订阅专栏

引自kw规则介绍
https://support.roguewave.com/documentation/klocwork/cn/2017/rlk.jndi/

RLK.JNDI

如果资源经过分配，但使用后未得到妥当处置，将报告 RLK（资源泄漏）问题。未能正确处置资源可能导致如下的问题：

打开太多文件
应用程序无法在需要时访问临时文件
RLK.JNDI 警告表明 JNDI 上下文未在退出时关闭。

漏洞与风险
流、连接以及图形对象之类的资源必须明确关闭。关闭操作可以取消对事务的拦截，或将文件更改刷新到文件系统中。虽然资源最终会被垃圾回收器关闭，但可能在启动垃圾回收之前就已经耗尽资源。根据资源的不同性质，如果对分配其他资源的尝试失败，将抛出各种不同的异常，例如 java.io.FileNotFoundException：打开的文件过多，或数据库连接过多。

缓解与预防
明确关闭所有具有关闭方法的资源，即使您认为不重要的资源亦应如此。这样将避免未来更改代码时出现这类错误。

示例 1

25     public NamingEnumeration<SearchResult> search(final String providerURL,
26                                                   final String name,
27                                                   final String filter,
28                                                   final SearchControls cons) {
29         try {
30             Hashtable environment = new Hashtable();
31             environment.put(INITIAL_CONTEXT_FACTORY, INITIAL_CONTEXT_FACTORY);
32             environment.put(Context.PROVIDER_URL, providerURL);
33             environment.put(Context.SECURITY_AUTHENTICATION, SECURITY_AUTHENTICATION);
34             InitialLdapContext context = new InitialLdapContext(environment, null);
35 
36             NamingEnumeration<SearchResult> result = context.search(name, filter, cons);  // Resource allocated
37             return result;
38         } catch (NamingException e) {
39             System.err.println("LDAP search failed: " + e.getMessage());
40         }
41         return null;
42     }

对第 34 行的代码段报告 RLK.JNDI：JNDI 上下文“context”未在退出时关闭。

示例 2

25     public NamingEnumeration<SearchResult> search(final String providerURL,
26                                                   final String name,
27                                                   final String filter,
28                                                   final SearchControls cons) {
29         try {
30             Hashtable environment = new Hashtable();
31             environment.put(INITIAL_CONTEXT_FACTORY, INITIAL_CONTEXT_FACTORY);
32             environment.put(Context.PROVIDER_URL, providerURL);
33             environment.put(Context.SECURITY_AUTHENTICATION, SECURITY_AUTHENTICATION);
34 
35             InitialLdapContext context = new InitialLdapContext(environment, null); // Resource allocated
36 
37             try {
38                 NamingEnumeration<SearchResult> result = context.search(name, filter, cons);
39                 return result;
40             } finally {
41                 context.close(); // Resource released
42             }
43         } catch (NamingException e) {
44             System.err.println("LDAP search failed: " + e.getMessage());
45         }
46 
47         return null;
48     }

来自之前部分的代码段经过了修复；在此不会报告 RLK.JNDI。

JNDI定义：

引用自：http://www.cnblogs.com/chinafine/archive/2010/06/16/1759246.html

下面来自java.sun.com：
Java命名和目录接口（Java Naming and Directory Interface ，JNDI）是用于从Java应用程序中访问名称和目录服务的一组API。命名服务即将名称与对象相关联，以便能通过相应名称访问这些对象。而目录服务即其对象具有属性及名称的命名服务。

命名或目录服务允许您集中管理共享信息的存储，这在网络应用程序中很重要，因为它可以使这类应用程序更加一致和易于管理。例如，可以将打印机配置存储在目录服务中，这样所有与打印机相关的应用程序都能够使用它。

为什么会有jndi
jndi诞生的理由似乎很简单。随着分布式应用的发展，远程访问对象访问成为常用的方法。虽然说通过 Socket等编程手段仍然可实现远程通信，但按照模式的理论来说，仍是有其局限性的。RMI技术，RMI-IIOP技术的产生，使远程对象的查找成为了技术焦点。JNDI技术就应运而生。JNDI技术产生后，就可方便的查找远程或是本地对象。

JNDI的架构与实现
这里写图片描述
JNDI的架构与JDBC的架构非常类似.JNDI架构提供了一组标准命名系统的API,这些API在JDK1.3之前是作为一个单独的扩展包jndi.jar,这个基础API构建在与SPI之上。这个API提供如下五个包
javax.naming
javax.naming.directory
javax.naming.event
javax.naming.ldap
javax.naming.spi
在应用程序中,我们实际上只使到用以上几个包的中类.具体调用类及通信过程对用户来说是透明的.
JNDI API提供了访问不同JNDI服务的一个标准的统一的实现,其具体实现可由不同的 Service Provider来完成。前面讲的为第一层JNDI API层.

最下层为JNDI SPI API及其具体实现。

图中所列的一些SPI可从http://java.sun.com/products/jndi/downloads/index.html下载.

它包括了几个增强和下面的命名/目录服务提供者：
LDAP(Lightweight Directory Access Protocol)服务提供者
CORBA COS（Common Object Request Broker Architecture Common Object Services）命名服务提供者
RMI(Java Remote Method Invocation)注册服务提供者
DNS(Domain Name System)服务提供者.
FSSP(File System Service Provider)文件系统服务提供者
其它服务提供者

中间层为命名管理层。其功能应该由JNDI SPI来完成。上层为JNDI API,这个API包在Java 2 SDK 1.3及以上的版本中已经包括。

前面讲解的只是作为应用程序客户端的架构实现,其服务端是由SPI对应的公司/厂商来实现的,我们只需将服务端的相关参数传给JNDI API就可以了,具体调用过程由SPI来完成.

JNDI工作原理

下面通过一个示例程序来说明JNDI工作原理(代码为自解释).

/*
    * Created on 2005-3-4
    *
    * To change the template for this generated file go to
    * Window&gt;Preferences&gt;Java&gt;Code Generation&gt;Code and Comments
    */
    package com.sily.jndi;
    import java.io.FileInputStream;
    import java.util.Properties;
    import javax.naming.Context;
    import javax.naming.InitialContext;
    /**
    * @author shizy
    *
    * To change the template for this generated type comment go to
    * Window&gt;Preferences&gt;Java&gt;Code Generation&gt;Code and Comments
    */
    public class TestJbossJNDI {
    /**
    *
    */
    public TestJbossJNDI() {
    super();
    // TODO Auto-generated constructor stub
    }
    public static void main(String[] args) { try {
    Properties env = new Properties();
    //载入jboss的SPI相关参数,包括初始上下文工厂，服务URL，等等
    env.load(new FileInputStream("jbossJndi.properties"));
    env.list(System.out);
    //通过JNDI api 初始化上下文
    InitialContext ctx = new javax.naming.InitialContext(env);
    System.out.println("Got context");
    //create a subContext
    ctx.createSubcontext("/sylilzy");
    ctx.createSubcontext("sylilzy/sily");
    //rebind a object
    ctx.rebind("sylilzy/sily/a", "I am sily a!");
    ctx.rebind("sylilzy/sily/b", "I am sily b!");
    //lookup context
    Context ctx1=(Context)ctx.lookup("sylilzy");
    Context ctx2=(Context)ctx1.lookup("/sylilzy/sily");
    ctx2.bind("/sylilzy/g", "this is g");
    //lookup binded object
    Object o;
    o=ctx1.lookup("sily/a");
    System.out.println("get object from jndi:"+o);
    //rename the object
    ctx2.rename("/sylilzy/g", "g1");
    o=ctx2.lookup("g1");
    System.out.println("get object from jndi:"+o);
    } catch (Exception e) {
    e.printStackTrace();
    }
    }
    }

结果输出如下:
– listing properties –
java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory
java.naming.provider.url=jnp://localhost:1099
java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces
Got context
get object from jndi:I am sily a!
get object from jndi:this is g

程序中jbossJndi.properties文件的内容为:
java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory
java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces
java.naming.provider.url=jnp://localhost:1099

注意:要正确运行示例程序,请启动jboss,并将jboss的jbossall-client.jar文件放入classpath中。

上述示例程序在jboss服务器的jndi树上建立了几个上下文,并bind了几对象,大家可通过附录中的代码或其它工具查看

查看结果为：
-----------------------------
/sylilzy/sily
-----------------------------
/sylilzy/sily/b:I am sily b!
/sylilzy/sily/a:I am sily a!
/sylilzy/sily/g1:this is g
-----------------------------

上述程序中，我们的代码只涉及到了jndi API，其它细节如初始化jboss jndi的初始上下文，建立网络连接，与服务器通信，对我们来说都是透明的，另外，我们将jboss jndi的spi包中的类名作为参数传入了程序中,要访问一个远程对象，我们所做的就这么多。

下面，再提供一个例子，与上例不同，我们不需要 jboss,我们使用sun的FSSP(File System Service Provider)文件系统服务提供者.注意在这个例子中要使用到前面所说的File System Service Provider for the Java Naming and Directory InterfaceTM (JNDI)相关类（下载）。

/*
    * Created on 2005-3-1
    *
    * To change the template for this generated file go to
    * Window&gt;Preferences&gt;Java&gt;Code Generation&gt;Code and Comments
    */
    package com.sily.jndi;
    import java.io.FileInputStream;
    import java.util.Properties;
    import javax.naming.*;
    import javax.naming.Context;
    import javax.naming.InitialContext;
    /**
    * @author shizy
    *
    * To change the template for this generated type comment go to
    * Window&gt;Preferences&gt;Java&gt;Code Generation&gt;Code and Comments
    */
    public class JndiTest1 {
    /**
    *
    */
    public JndiTest1() {
      super();
      // TODO Auto-generated constructor stub
     }
     public static void main(String[] args) {
      try {
       Properties env = new Properties();
       env.load(new FileInputStream("fileSystemService.properties"));
       env.put(Context.PROVIDER_URL, "file:///c:/");
       Context ctx = new InitialContext(env);
       ctx.createSubcontext("sylilzy");

    NamingEnumeration list = ctx.list("/");
       while (list.hasMore()) {
        NameClassPair nc = (NameClassPair) list.next();
        System.out.println(nc);
       }

    }
      catch (Exception e) {
       e.printStackTrace();
      }
     }
    }