org.jdbi.v3.stringtemplate3.UseStringTemplateSqlLocator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdbi3-string-template Show documentation
jdbi-string-template locates SQL statements in StringTemplate files on the classpath
There is a newer version: 3.0.0-alpha7
Show newest version
/*
 * 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.jdbi.v3.stringtemplate3;

import static org.jdbi.v3.stringtemplate3.StringTemplateSqlLocator.findStringTemplateGroup;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.function.Consumer;

import org.antlr.stringtemplate.StringTemplate;
import org.antlr.stringtemplate.StringTemplateGroup;
import org.jdbi.v3.core.config.ConfigRegistry;
import org.jdbi.v3.core.statement.SqlStatements;
import org.jdbi.v3.core.rewriter.ColonPrefixStatementRewriter;
import org.jdbi.v3.core.rewriter.StatementRewriter;
import org.jdbi.v3.sqlobject.internal.SqlAnnotations;
import org.jdbi.v3.sqlobject.SqlObjects;
import org.jdbi.v3.sqlobject.config.ConfigurerFactory;
import org.jdbi.v3.sqlobject.config.ConfiguringAnnotation;
import org.jdbi.v3.sqlobject.locator.SqlLocator;

/**
 * Configures SQL Object to locate SQL using the {@link StringTemplateSqlLocator#findStringTemplateSql(Class, String)}
 * method. If the SQL annotation (e.g. @SqlQuery) defines a value (e.g. @SqlQuery("hello")),
 * that value ("hello") will be used for the name parameter; if undefined, the name of the SQL
 * object method will be used:
 *
 *  *     @UseStringTemplateSqlLocator
 *     interface Viccini {
 *         @SqlUpdate
 *         void doTheThing(long id);     // => StringTemplateSqlLocator.findStringTemplateSql(Viccini.class, "doTheThing")
 *
 *         @SqlUpdate("thatOtherThing")
 *         void doTheThing(String name); // => StringTemplateSqlLocator.findStringTemplateSql(Viccini.class, "thatOtherThing")
 *     }
 * 
 */
@ConfiguringAnnotation(UseStringTemplateSqlLocator.Factory.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface UseStringTemplateSqlLocator {
    Class value() default ColonPrefixStatementRewriter.class;

    class Factory implements ConfigurerFactory {
        @Override
        public Consumer createForType(Annotation annotation, Class sqlObjectType) {
            return create((UseStringTemplateSqlLocator) annotation, sqlObjectType);
        }

        @Override
        public Consumer createForMethod(Annotation annotation, Class sqlObjectType, Method method) {
            return create((UseStringTemplateSqlLocator) annotation, sqlObjectType);
        }

        private Consumer create(UseStringTemplateSqlLocator annotation, Class sqlObjectType) {
            SqlLocator locator = (type, method) -> {
                String templateName = SqlAnnotations.getAnnotationValue(method).orElseGet(method::getName);
                StringTemplateGroup group = findStringTemplateGroup(type);
                if (!group.isDefined(templateName)) {
                    throw new IllegalStateException("No StringTemplate group " + templateName + " for class " + sqlObjectType);
                }

                return templateName;
            };
            StatementRewriter delegate = createDelegate(annotation.value());
            StatementRewriter locatingRewriter = (sql, params, ctx) -> {
                String templateName = sql;

                StringTemplateGroup group = findStringTemplateGroup(sqlObjectType);
                StringTemplate template = group.getInstanceOf(templateName, ctx.getAttributes());
                String rewritten = template.toString();

                return delegate.rewrite(rewritten, params, ctx);
            };
            return config -> {
                config.get(SqlObjects.class).setSqlLocator(locator);
                config.get(SqlStatements.class).setStatementRewriter(locatingRewriter);
            };
        }

        private StatementRewriter createDelegate(Class type) {
            try {
                return type.getConstructor().newInstance();
            } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
                throw new IllegalStateException("Error instantiating delegate statement rewriter: " + type, e);
            }
        }
    }
}