Level 2

Solved

How can we fix the SonarQube issue in AEM where constructor injection should be used instead of field injection? We are encountering the mentioned issue when using the @Injection annotation.

4 replies
1869 views
Translate All

No text available

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.

Nishant-SinghAccepted solution

Adobe Employee

It seems you are using Spring J2EE rules also in SonarQube.

if Spring is not used then you can remove those rules.

if its really required to fix then you can write as below -

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.DefaultInjectionStrategy;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;

import com.day.cq.wcm.api.Page;

import javax.inject.Inject;
import javax.inject.Named;

@Model(adaptables = {SlingHttpServletRequest.class, Resource.class}, defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class TestModelConstructor {
    private String currentResourcePath;
    private String currentPagePagePath;
    private String requestParam;

    
    public TestModelConstructor(
            @ScriptVariable @Named("currentPage") final Page currentPage,
            @ScriptVariable @Named("resource") final Resource resource,
            @SlingObject @Named("slingHttpServletRequest") final SlingHttpServletRequest slingHttpServletRequest
    ) {
        currentResourcePath = resource.getPath();
        currentPagePagePath = currentPage.getPath();
        requestParam = slingHttpServletRequest.getParameter("myParam");
    }
}

EstebanBustamante

Adobe Champion and Community Advisor

A couple of things to check:
1) Are you using "javax.inject.Inject" annotation?

2) Are you using the specific annotation whenever possible instead of "Inject" all over the place?

I am not sure if you really want to use constructor injection instead, it maybe depends on the scenario, Can you post a sample code?

Translate

Esteban Bustamante

aanchal-sikka

Community Advisor

hello @nesan

Requesting you to please share the code (atleast the snippets) and the exact error that Sonarqube is reporting.

Translate

Aanchal Sikka

Tanika02

Level 7

Hello @nesan -

Do you have the AEM RulesSet Enabled/Configured in SonarQube? As I have not seen this error in recent times while using SonarQube!
Additionally, there is definitely a way how you can handle this via instead of using field injection, refactor the classes to use constructor injection. But it might not work pretty well if we do such refactoring at the Sling Model level or that would require higher efforts to handle.

Now we can definitely add exception to sonarQube to handle this but I would recommend raising an Adobe support case.

Translate

Nishant-Singh

Accepted solution

Adobe Employee

It seems you are using Spring J2EE rules also in SonarQube.

if Spring is not used then you can remove those rules.

if its really required to fix then you can write as below -

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.DefaultInjectionStrategy;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.ScriptVariable;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;

import com.day.cq.wcm.api.Page;

import javax.inject.Inject;
import javax.inject.Named;

@Model(adaptables = {SlingHttpServletRequest.class, Resource.class}, defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL)
public class TestModelConstructor {
    private String currentResourcePath;
    private String currentPagePagePath;
    private String requestParam;

    
    public TestModelConstructor(
            @ScriptVariable @Named("currentPage") final Page currentPage,
            @ScriptVariable @Named("resource") final Resource resource,
            @SlingObject @Named("slingHttpServletRequest") final SlingHttpServletRequest slingHttpServletRequest
    ) {
        currentResourcePath = resource.getPath();
        currentPagePagePath = currentPage.getPath();
        requestParam = slingHttpServletRequest.getParameter("myParam");
    }
}

Translate

Sign up

Login with SSO

Login to the community

Login with SSO