Forum:

Spring

Accessing Spring beans from jsp

Ranch Hand

Posts: 93

posted 9 years ago

Number of slices to send:

Optional 'thank-you' note:

Send

Hi,

I'm doing a course in Spring and my Spring MVC program prints the standard 'Hello World' message on the jsp page. Following are the
files concerned:

controller.HelloWorldController.java
--------------------------------------------------

Dispatcher servlet config file: dispatcher-servlet.xml
-------------------------------------------------------------------------

Entry point for application:index.jsp
--------------------------------------------------

helloworld.jsp
---------------------

web.xml
-------------

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://java.sun.com/xml/ns/javaee" 
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" 
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID"

version="3.0">
  
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
  </context-param>
  <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
  <display-name>FirstWebAppUsingSpringMVC</display-name>
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
  
  <servlet>
    <servlet-name>dispatcher</servlet-name>
     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>
  
  <servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
      <url-pattern>*.htm</url-pattern>
  </servlet-mapping>
  <session-config>
        <session-timeout>
            30
        </session-timeout>
    </session-config>
</web-app>

and successfully displays the 'Hello World' message on http://localhost:8080/FirstWebAppUsingSpringMVC/helloworld.htm

I was curious if Spring beans could be accessed from the jsp (googled and did some research on the web in this regard) and was
surprised that they indeed could be done (as provided by Spring designers in the form of exposedContextBeanNames and
exposeContextBeansAsAttributes properties of InternalResourceViewResolver).

[sidebar]
Whether business components should be exposed to the view is, I guess, a topic for another thread. I've initiated this topic as I'm more
concerned with the 'how to do it' for learning purposes.
[/sidebar]

To implement the same, I modified
controller.HelloWorldController.java
----------------------------------------------------

package controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.AbstractController;
import service.HelloWorldService;

public class HelloWorldController extends AbstractController {
        //property helloWorldService that references Service bean HelloWorldService
	private HelloWorldService helloWorldService;

//defined handleRequestInternal method of the AbstractController class
        //that returns a new ModelAndView object
       //Instance of ModelAndView adds logical viewName and model data as arguments
    	@Override
	protected ModelAndView handleRequestInternal(HttpServletRequest request,
	HttpServletResponse response) throws Exception {
        // TODO Auto-generated method stub
	ModelAndView mv = new ModelAndView("helloworld");//view passed as string to new ModelAndView object
        //instance of Service class accessing its object i.e method that displays Hello World
  	mv.addObject("helloworld", helloWorldService.dispMessage());
        return mv;
	}
	
                  //generate setter and getter for the property
                  //implicitly injecting business component within Controller
	public void setHelloWorldService(HelloWorldService helloWorldService) {
		    this.helloWorldService = helloWorldService;
	}

/**
	 * @return the helloWorldService
	 */
	public HelloWorldService getHelloWorldService() {
		return helloWorldService;
	}	
}

Dispatcher servlet config file: dispatcher-servlet.xml
-------------------------------------------------------------------------

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans

http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/context

http://www.springframework.org/schema/context/spring-context-3.0.xsd">
    

<bean id="controllerclasshandlermapping"
    class="org.springframework.web.servlet.mvc.support.ControllerClassNameHandlerMapping">
</bean>
        

   <bean id="viewResolver"
          class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          p:prefix="/WEB-INF/jsp/"
          p:suffix=".jsp">

          <property name="exposedContextBeanNames">
            <list>
             <value>helloWorldController</value>
            </list>
          </property>    
    </bean> 
            

    <bean id= "helloWorldController"
      class="controller.HelloWorldController" p:helloWorldService-ref="helloWorldService"/>

</beans>

helloworld.jsp
---------------------

web.xml
-------------

and introduced
service.HelloWorldService.java (Service bean)
-------------------------------------------------------------------

applicationContext.xml
----------------------------------

However, on running the project, the output on http://localhost:8080/FirstWebAppUsingSpringMVC/helloworld.htm is

Why is the 'Hello World' message not displayed? Where have I gone wrong??.......have been trying to work around this but unable
to find solution.

Much appreciated if the forum members / experts could help in resolving the same.

Thanks,
Sudhir

Ayan mallick

Ranch Hand

Posts: 46

posted 9 years ago

Number of slices to send:

Optional 'thank-you' note:

Send

<body>

${helloWorldController.helloWorldService}
</body>

let me try in this way

make your service class a java bean. declare message as a property and generate setter & getter.

then access the property not the object itself what you are doing here.

then ithink it would print the message.

but could you tell me please why do we need to expose a controller or service bean i mean from business perspective.any scenario where we need to enable such functionality.

Regards

Ayan

Sudhir Srinivasan

Ranch Hand

Posts: 93

posted 9 years ago

Number of slices to send:

Optional 'thank-you' note:

Send

Thank you for your response. As suggested

Ayan mallick wrote:
make your service class a java bean. declare message as a property and generate setter & getter.

then access the property not the object itself what you are doing here.

 ${helloWorldController.helloWorldService.message}

then ithink it would print the message.

I'll try out the same and get back to you.

Ayan mallick wrote:but could you tell me please why do we need to expose a controller or service bean i mean from business perspective.

As I'd mentioned in my original post, spring does provide the properties that enables spring beans - specific beans or all the beans in the application - to be exposed to the view. I tried implementing the same for learning purposes only (exposing business components to the view is debatable and not generally encouraged, from what I've learned on the web).

There are always exceptions to the rule and

Ayan mallick wrote:any scenario where we need to enable such functionality.

this could be a possible explanation (in relation to a specific query by a poster on another forum.
Whether you agree or disagree is entirely up to you

).

Regards,
Sudhir

Sudhir Srinivasan

Ranch Hand

Posts: 93

posted 9 years ago

Number of slices to send:

Optional 'thank-you' note:

Send

Accessing the bean property

Sudhir Srinivasan wrote:Thank you for your response. As suggested

Ayan mallick wrote:
make your service class a java bean. declare message as a property and generate setter & getter.

then access the property not the object itself what you are doing here.

 ${helloWorldController.helloWorldService.message}

then ithink it would print the message.

I'll try out the same and get back to you.

instead of the bean itself works (although my original intent to expose just the object does not seem to be implementable....). A quick summary of how it works:

a) declare property 'message' in the service bean
b) generate setter & getter for the same
c) controller bean to reference service bean in the dispatcher servlet config file
d) in applicationContext.xml, define 'message' property in bean 'helloWorldService' and inject the "Hello World" message into the property.

Regards,
Sudhir