All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jooby.scanner.Scanner Maven / Gradle / Ivy

Go to download

The newest version!
/**
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "{}"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2014 Edgar Espina
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.jooby.scanner;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.google.common.util.concurrent.Service;
import com.google.common.util.concurrent.ServiceManager;
import com.google.inject.Binder;
import com.google.inject.Module;
import com.typesafe.config.Config;
import io.github.classgraph.ClassGraph;
import io.github.classgraph.ClassInfo;
import io.github.classgraph.ScanResult;
import org.jooby.Env;
import org.jooby.Jooby;
import org.jooby.Router;
import org.jooby.funzy.Throwing;

import static org.jooby.funzy.Throwing.throwingSupplier;

import org.jooby.mvc.Path;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Named;
import javax.inject.Provider;
import javax.inject.Singleton;
import java.lang.reflect.Modifier;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Collectors;

/**
 * 
scanner

 * 

 * Classpath scanning services via
 * FastClasspathScanner.
 * FastClasspathScanner is an uber-fast, ultra-lightweight classpath scanner for Java, Scala and
 * other JVM languages.
 * 

 *
 * 
usage

 *
 * 
{@code
 * {
 *   use(new Scanner());
 * }
 * }

 *
 * 

 * This modules scan the application class-path and automatically discover and register
 * MVC routes/controllers and {@link Jooby} applications.
 * 

 *
 * 

 * It scans the application package. That's the package where your bootstrap application belong to.
 * Multi-package scanning is available too:
 * 

 *
 * 
{@code
 * {
 *   use(new Scanner("foo", "bar"));
 * }
 * }

 *
 * 
services

 *
 * 

 * The next example scans and initialize any class in the application package annotated with
 * Named:
 * 

 *
 * 
{@code
 * {
 *   use(new Scanner()
 *     .scan(Named.class)
 *   );
 * }
 * }

 *
 * 

 * The next example scans and initialize any class in the application package that implements
 * MyService:
 * 

 *
 * 
{@code
 * {
 *   use(new Scanner()
 *     .scan(MyService.class)
 *   );
 * }
 * }

 *
 * 

 * Guava {@link Service} are also supported:
 * 

 *
 * 
{@code
 * {
 *   use(new Scanner()
 *     .scan(com.google.common.util.concurrent.Service.class)
 *   );
 *
 *   get("/guava", req -> {
 *     ServiceManager sm = req.require(ServiceManager.class);
 *     ...
 *   });
 * }
 * }

 *
 * 

 * They are added to {@link ServiceManager} and started and stopped automatically.
 * 

 *
 * 

 * Raw/plain Guice {@link Module} are supported too
 * 

 * :
 *
 * 
{@code
 * {
 *   use(new Scanner()
 *     .scan(Module.class)
 *   );
 * }
 * }

 *
 * 

 * Of course, you can combine two or more strategies:
 * 

 *
 * 
{@code
 * {
 *   use(new Scanner()
 *     .scan(MyService.class)
 *     .scan(Named.class)
 *     .scan(Singleton.class)
 *     .scan(MyAnnotation.class)
 *   );
 * }
 * }

 *
 * 

 * In all cases, services are created as singleton and started/stopped automatically
 * when {@link PostConstruct} and {@link PreDestroy} annotations are present.
 * 

 *
 * @author edgar
 * @since 1.0.0
 */
public class Scanner implements Jooby.Module {

  @SuppressWarnings("rawtypes")
  private static final Predicate A = Class::isAnnotation;

  @SuppressWarnings("rawtypes")
  private static final Predicate C = k -> !Modifier.isAbstract(k.getModifiers());

  @SuppressWarnings("rawtypes")
  private static final Predicate I = A.negate().and(Class::isInterface);

  @SuppressWarnings("rawtypes")
  private static final Predicate S = I.or(A).negate();

  private List packages;

  @SuppressWarnings("rawtypes")
  private final Set serviceTypes = new LinkedHashSet<>();

  /**
   * Creates a new {@link Scanner} and uses the provided scan spec or packages.
   *
   * @param scanSpec Scan spec or packages. See Scan
   *        spec.
   */
  public Scanner(final String... scanSpec) {
    this.packages = Lists.newArrayList(scanSpec);
  }

  /**
   * Creates a new {@link Scanner} and use the application package (a.k.a as namespace).
   */
  public Scanner() {
  }

  @SuppressWarnings({"unchecked", "rawtypes"})
  @Override
  public void configure(final Env env, final Config conf, final Binder binder) {
    List packages = Optional.ofNullable(this.packages)
        .orElseGet(() -> ImmutableList.of(conf.getString("application.ns")));
    Set spec = Sets.newLinkedHashSet(packages);
    serviceTypes.forEach(it -> spec.add(it.getPackage().getName()));

    ClassGraph scanner = new ClassGraph().enableAllInfo()
        .whitelistPackages(spec.toArray(new String[spec.size()]));

    Router routes = env.router();

    ClassLoader loader = getClass().getClassLoader();
    Throwing.Function loadClass = loader::loadClass;

    // bind once as singleton + post/pre callbacks
    Set bindings = new HashSet<>();
    Predicate once = bindings::add;

    Consumer bind = klass -> {
      binder.bind(klass).asEagerSingleton();
      env.lifeCycle(klass);
    };

    ScanResult result = scanner.scan();

    Predicate inPackage = c -> packages.stream()
        .anyMatch(c.getName()::startsWith);

    /** Controllers: */
    result.getClassesWithAnnotation(Path.class.getName())
        .stream()
        .filter(once)
        .map(ClassInfo::getName)
        .map(loadClass)
        .filter(C)
        .forEach(routes::use);

    String mainClass = conf.getString("application.class");
    /** Apps: */
    result.getSubclasses(Jooby.class.getName())
        .stream()
        .filter(once)
        .map(ClassInfo::getName)
        .filter(name -> !name.equals(mainClass))
        .map(loadClass)
        .filter(C)
        .forEach(klass -> routes.use(((Jooby) newObject(klass))));

    /** Annotated with: */
    serviceTypes.stream()
        .filter(A)
        .forEach(a -> result.getClassesWithAnnotation(a.getName())
            .stream()
            .filter(once)
            .map(ClassInfo::getName)
            .map(loadClass)
            .filter(C)
            .forEach(bind));

    /** Implements: */
    serviceTypes.stream()
        .filter(I)
        .filter(type -> type != Jooby.Module.class && type != Module.class && type != Service.class)
        .forEach(i -> result.getClassesImplementing(i.getName())
            .stream()
            .filter(inPackage)
            .filter(once)
            .map(ClassInfo::getName)
            .map(loadClass)
            .filter(C)
            .forEach(bind));

    /** SubclassOf: */
    serviceTypes.stream()
        .filter(S)
        .forEach(k -> result.getSubclasses(k.getName())
            .stream()
            .filter(inPackage)
            .filter(once)
            .map(ClassInfo::getName)
            .map(loadClass)
            .filter(C)
            .forEach(bind));

    /** Guice modules: */
    if (serviceTypes.contains(Module.class)) {
      result.getClassesImplementing(Module.class.getName())
          .stream()
          .filter(inPackage)
          .filter(once)
          .map(ClassInfo::getName)
          .map(loadClass)
          .filter(C)
          .forEach(klass -> ((Module) newObject(klass)).configure(binder));
    }

    /** Guava services: */
    if (serviceTypes.contains(Service.class)) {
      Set> guavaServices = new HashSet<>();
      result.getClassesImplementing(Service.class.getName())
          .stream()
          .filter(inPackage)
          .filter(once)
          .map(ClassInfo::getName)
          .map(loadClass)
          .filter(C)
          .forEach(guavaServices::add);

      if (guavaServices.size() > 0) {
        guavaServices(env, binder, guavaServices);
      }
    }
  }

  /**
   * Add a scan criteria like an annotation, interface or class.
   *
   * @param type A scan criteria/type.
   * @return This module.
   */
  public Scanner scan(final Class type) {
    // standard vs guice annotations
    if (type == Named.class || type == com.google.inject.name.Named.class) {
      serviceTypes.add(Named.class);
      serviceTypes.add(com.google.inject.name.Named.class);
    } else if (type == Singleton.class || type == com.google.inject.Singleton.class) {
      serviceTypes.add(Singleton.class);
      serviceTypes.add(com.google.inject.Singleton.class);
    } else {
      serviceTypes.add(type);
    }
    return this;
  }

  private static  T newObject(final Class klass) {
    return throwingSupplier(klass::newInstance).get();
  }

  @SuppressWarnings({"unchecked", "rawtypes"})
  private static void guavaServices(final Env env, final Binder binder,
      final Set> serviceTypes) {
    Consumer guavaService = klass -> {
      binder.bind(klass).asEagerSingleton();
      serviceTypes.add(klass);
    };

    serviceTypes.forEach(guavaService);
    // lazy service manager
    AtomicReference sm = new AtomicReference<>();
    Provider smProvider = sm::get;
    binder.bind(ServiceManager.class).toProvider(smProvider);
    // ask Guice for services, create ServiceManager and start services
    env.onStart(r -> {
      List services = serviceTypes.stream()
          .map(r::require)
          .collect(Collectors.toList());
      sm.set(new ServiceManager(services));
      sm.get().startAsync().awaitHealthy();
    });
    // stop services
    env.onStop(() -> sm.get().stopAsync().awaitStopped());
  }

  @SuppressWarnings({"unchecked", "rawtypes"})
  private static Predicate type(final Class type) {
    return klass -> klass.isAssignableFrom(type);
  }

}
    

    

    
            
    
            







    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy