ASP.NET WebForms

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Wed, 02 Feb 2011 02:18:23 GMT

Λοιπόν, αν κατάλαβα καλά τί υποννοεί ο spaceman, λέει ότι αν φτιάξεις ένα κλασσικό asmx web service, το μόνο που χρειάζεται από την πλευρά του service για να επιστρέψει Json είναι να βάλεις το ScriptService attribute στην κλάση, το ScriptMethod attribute στη μέθοδο και να ορίσεις ως ResponseFormat το Json - χωρίς μετατροπές με το χέρι. Έτσι το service που είχα γράψει νωρίτερα γίνεται:

 [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    // To allow this Web Service to be called from script, using ASP.NET AJAX, uncomment the following line. 
    [System.Web.Script.Services.ScriptService]
    public class WebService1 : System.Web.Services.WebService
    {

        [WebMethod,ScriptMethod(ResponseFormat=ResponseFormat.Json,UseHttpGet=true)]
        public List<CustomerDetails> GetCustomers()
        {
            using (var dbContext = new AdventureWorksEntities())
            {
                var customers = (from customer in dbContext.Customers
                                 where customer.CustomerType == "I"
                                 select new CustomerDetails
                                 {
                                     CustomerID = customer.CustomerID,
                                     AccountNumber = customer.AccountNumber
                                 }).Take(5);
                var list = customers.ToList();
                return list;
            }
        }

    }

Το κομμάτι σε bold διαφέρει από αυτά που έγραφαν τα posts στα οποία παραπέμπει ο spaceman. Τα posts αναφέρουν ότι υπάρχει vulnerability όταν καλείς Json arrays με GET, αυτό όμως δεν ισχύει όταν χρησιμοποιείς ASMΧ γιατί δεν σου επιστρέφει γυμνό array.

O client όμως θα πρέπει να ορίσει το Json στο Content-Type header. Για παράδειγμα, ένας C# client θα πρέπει να κάνει το παρακάτω:

 WebClient client=new WebClient();
 client.Headers["Content-Type"] = "application/json; charset=utf-8";            
 var data=client.DownloadString(@"http://localhost/WcfJsonTest/WebService1.asmx/GetCustomers");
 Console.Write(data);

Το αποτέλεσμα είναι

{"d":[{"__type":"WcfJsonTest.CustomerDetails","CustomerID":11000,"AccountNumber":"AW00011000"},{"__type":"WcfJsonTest.CustomerDetails","CustomerID":11001,"AccountNumber":"AW00011001"},{"__type":"WcfJsonTest.CustomerDetails","CustomerID":11002,"AccountNumber":"AW00011002"},{"__type":"WcfJsonTest.CustomerDetails","CustomerID":11003,"AccountNumber":"AW00011003"},{"__type":"WcfJsonTest.CustomerDetails","CustomerID":11004,"AccountNumber":"AW00011004"}]}

Όπως βλέπουμε, το array περικλείεται στο d property κι έτσι δεν υπάρχει πρόβλημα.

Αυτό εννοούσες spaceman?

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Wed, 02 Feb 2011 01:53:18 GMT

Χμμ, δεν θα το έλεγα misconception, απλά άγνοια μίας παλιάς και λίγο ξεπερασμένης τεχνολογίας.

Αν κατάλαβα πάντως, αυτό υποννοείς με τις παραπομπές, σε μία φράση, είναι ότι και με ASMX παίζει, φτάνει να ΜΗΝ γυρίσεις string?

Απ: web service that returns JSON string

spaceman — Wed, 02 Feb 2011 01:29:34 GMT

http://stackoverflow.com/questions/3311681/android-how-to-access-data-in-an-asp-net-database-via-app

Your webservice will still return XML (so you can use it with a soap client) unless you make a HTTPPost request with content-type "application/json"

http://encosia.com/2010/03/03/asmx-and-json-common-mistakes-and-misconceptions/
One of the most stubbornly persistent misconceptions about ASMX services is the rumor that they are limited to returning XML. With that notion mind, many developers understandably avoid them for client-side AJAX callbacks. When every byte counts, raw JSON is always preferable to the bloat of XML.However, the introduction of ASP.NET AJAX removed that XML limitation.
In any ASP.NET 2.0+ AJAX enabled site, one of ASP.NET AJAX’s additions is something called the ScriptService. When a ScriptService is called in the correct manner, it automatically returns its result serialized as JSON instead of XML.

--HTH--

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Tue, 01 Feb 2011 20:33:50 GMT

Αν όταν ο DaltonGR λέει web services εννοεί τα παλιά ASMX web services αρχίζει να βγαίνει νόημα. Εξηγείται έτσι και το WebMethod attribute στην αρχή, το οποίο δεν είχα προσέξει. Εκεί όμως δεν υπάρχει καμμία υποστήριξη για να επιστρέψεις κάτι πέρα από SOAP XML οπότε δεν είναι δυνατόν να ξεφορτωθείς τους xml headers. Επίσης, πρέπει να κάνεις τη μετατροπή σε JSON με το χέρι, με αποτέλεσμα να βγει πολύ περισσότερος κώδικας απ' ότι χρειάζεται.

Για παράδειγμα, παρακάτω είναι όλος ο κώδικας που χρειάστηκε να γράψω για να βγάλω δεδομένα ως JSON.

To web service (κομπλέ με data class και interface). Έφτιαξα ένα Entity Model μόνο με τον πίνακα Customers ( Add > New Item > Data > ADO.NET Data Entity Model και διάλεξα μόνο τον πίνακα Customers από τη λίστα)

 [DataContract]
    public class CustomerDetails
    {
        [DataMember]
        public int CustomerID { get; set; }
        [DataMember]
        public string AccountNumber { get; set; }
    }

    [ServiceContract]
    public interface ICustomerService
    {
        [OperationContract, WebGet(
            ResponseFormat = WebMessageFormat.Json,
            RequestFormat=WebMessageFormat.Json,
            UriTemplate="Customers")]
        List<CustomerDetails> GetCustomers();
    }

    public class CustomerService : ICustomerService
    {
        public List<CustomerDetails> GetCustomers()
        {
            using (var dbContext = new AdventureWorksEntities())
            {
                var customers = (from customer in dbContext.Customers
                                where customer.CustomerType== "I"
                                select new CustomerDetails
                                           {
                                               CustomerID=customer.CustomerID,
                                               AccountNumber=customer.AccountNumber
                                           }).Take(5);
                var list = customers.ToList();
                return list;
            }
        }
    }

και το web.config. Με κόκκινο οι γραμμές που χρειάστηκε να προσθέσω:

<?xml version="1.0"?>
<configuration>

  <system.web>
    <compilation debug="true" targetFramework="4.0"><assemblies><add assembly="System.Data.Entity, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /></assemblies></compilation>
  </system.web>
  <system.serviceModel>
	  
	  <services>
		  <service name="WcfJsonTest.CustomerService">
			  <endpoint address="" behaviorConfiguration="WcfJsonTest.TestServiceBehavior" binding="webHttpBinding" contract="WcfJsonTest.ICustomerService">
			  </endpoint>
		  </service>
	  </services>

	  <behaviors>
		  <endpointBehaviors>
			  <behavior name="WcfJsonTest.TestServiceBehavior">
				  <webHttp helpEnabled="true" />
			  </behavior>
		  </endpointBehaviors>
		  <serviceBehaviors>
        <behavior>		
          <!-- To avoid disclosing metadata information, set the value below to false and remove the metadata endpoint above before deployment -->
          <serviceMetadata httpGetEnabled="true" />
          <!-- To receive exception details in faults for debugging purposes, set the value below to true.  Set to false before deployment to avoid disclosing exception information -->
          <serviceDebug includeExceptionDetailInFaults="true" />
			
        </behavior>
      </serviceBehaviors>

	  </behaviors>
    <serviceHostingEnvironment multipleSiteBindingsEnabled="true"/>
  </system.serviceModel>
 <system.webServer>
    <modules runAllManagedModulesForAllRequests="true" />
  </system.webServer>
  
<connectionStrings><add name="AdventureWorksEntities" connectionString="metadata=res://*/Model1.csdl|res://*/Model1.ssdl|res://*/Model1.msl;provider=System.Data.SqlClient;provider connection string=&quot;Data Source=.;Initial Catalog=AdventureWorks;Integrated Security=True;MultipleActiveResultSets=True&quot;" providerName="System.Data.EntityClient" /></connectionStrings></configuration>

To περίεργο connection string χρησιμοποιείται από το Entity Framework για τη σύνδεση στη βάση, το οποίο δημιουργήθηκε από τον wizard του EF

Απ: web service that returns JSON string

dimos.homatas — Tue, 01 Feb 2011 20:16:40 GMT

Παναγιώτη το λέω γιατί είδα αυτό:

DaltonGR:
μάλλον θα μείνω προσωρινά με τα web services, γιατί απο ότι καταλαβαίνω θέλει αρκετό χρόνο, και επειδή για αρχή θα πρέπει να λειτουργεί κάποιο service πιλοτικά.

και υπέθεσα ότι μιλάμε για τα απλά xml web services. Τώρα, τι έχει γίνει με το γενικότερο "πακετάρισμα" κάτω από το WCF στο 4άρι .ΝΕΤ, δεν γνωρίζω. Είχα την εντύπωση πάντως ότι όλα θα αποτελούσαν μέρος του WCF.

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Tue, 01 Feb 2011 19:59:34 GMT

dimos.homatas:
Μμμμμ, νόμιζα ότι έλεγες για τα WCF services, sorry.

Μα γι αυτά λέω. Μπορείς να ορίσεις σε ένα WCF service να επιστρέφει XML ή JSON.

Τα WCF Data Services απλά βολεύουν στο σενάριο του DaltonGR περισσότερο από τα απλά WCF Services.

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Tue, 01 Feb 2011 19:56:16 GMT

Όσον αφορά το xml header, ΜΗΝ μετατρέπεις ΤΙΠΟΤΕ σε string. Τη μετατροπή την κάνει το ίδιο το WCF αφού του είπες να χρησιμοποιήσει JSON. Η ερώτηση στο StackOverflow ρωτάει ακριβώς γιατί εμφανίζεται το XML Header και του απαντάνε να ΜΗΝ προσπαθήσει ο ίδιος να κάνει την μετατροπή και να ΜΗΝ επιστρέψει string.

Απ: web service that returns JSON string

dimos.homatas — Tue, 01 Feb 2011 19:55:44 GMT

Μμμμμ, νόμιζα ότι έλεγες για τα WCF services, sorry.

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Tue, 01 Feb 2011 19:53:07 GMT

Δήμο, ήδη δείξαμε ότι όντως επιστρέφουν προσθέτωντας ένα attribute στο operation και μερικές γραμμές στο web.config.

DaltonGR, τα WCF Data Services τα ανέφερα γιατί είναι πολύ πιο εύκολο και γρήγορο να κάνεις αυτό που ζητάς με αυτά - φτιάχνεις ένα μοντέλο από τη βάση με drag & drop και το κάνεις expose με 5 γραμμές! Σίγουρα πολύ λιγότερο κώδικα από αυτόν που έγραψες για το post σου. Επιπλέον, ο κώδικας που έγραψες σε δεσμεύει σε ένα και μόνο. Τα WCF Data Services σου επιτρέπουν να κάνεις όποιο query θέλεις από τη μεριά του client, φτάνει να κάνεις expose τους κατάλληλους πίνακες ως entities.

Απ: web service that returns JSON string

dimos.homatas — Tue, 01 Feb 2011 19:40:54 GMT

Έχω την αμυδρή εντύπωση ότι τα web services δεν επιστρέφουν json, αν και δεν είμαι σίγουρος. Από όσο ξέρω τα λέγανε XML Web Services.

Quick n Dirty solution:

Φτιάχνεις ένα container αντικείμενο και έχεις ένα method το οποίο κάνει dump το json string. Οπότε παίρνεις ένα xml αντικείμενο από το service, πχ το myObject και απλά του λες κάτι του στυλ string s = myObject.DumpToJSon();

Παίρνεις μετά το s και το κάνεις deserialize (κάπου έχει πάρει το μάτι ένα JSon.NET)

Βέβαια από ότι καταλαβαίνω μάλλον θέλεις να αποφύγεις εντελώς το xml, και όχι απλά να το έχεις ως περιτύλιγμα για το json.

Από την άλλη, μήπως τα πράγματα θα ήταν πιο απλά εάν δεν χρησιμοποιούσες web service και έκανες ένα dump το json string?

my 2 cents...

Απ: web service that returns JSON string

DaltonGR — Tue, 01 Feb 2011 18:49:20 GMT

μάλλον θα μείνω προσωρινά με τα web services, γιατί απο ότι καταλαβαίνω θέλει αρκετό χρόνο, και επειδή για αρχή θα πρέπει να λειτουργεί κάποιο service πιλοτικά. Λοιπόν έχω την παρακάτω web method

 <WebMethod()> _
    <ScriptMethod(ResponseFormat:=ResponseFormat.Json)> _
    Public Function getAllCustomers() As String
        Using myConnection As New SqlConnection("Data Source=.\sqlexpress;Initial Catalog=DBName;Integrated Security=True;User ID=sa;Password=;")
            If myConnection.State = ConnectionState.Closed Then
                myConnection.Open()
            End If

            Dim DRAllData As SqlDataReader
            Dim myCommand As New SqlCommand
            myCommand.Connection = myConnection
            myCommand.CommandType = CommandType.Text

            Try
                myCommand.CommandText = "Select Top 10 CustomerID,FName,LName From Customers"
                DRAllData = myCommand.ExecuteReader

                Dim DTAllData As New DataTable
                DTAllData.Load(DRAllData)

                Return ConvertJSON.GetJSONString(DTAllData)
            Catch ex As Exception
                Return ""
            End Try
        End Using
    End Function

γίνεται convert sε μορφή Json με την παρακάτω κλάση,

    'Μετατρέπει ένα DataTable με δεδομένα σε JSON αντικείμενο.
    Public Shared Function GetJSONString(ByVal Dt As DataTable) As String
        Dim StrDc As String() = New String(Dt.Columns.Count - 1) {}

        Dim HeadStr As String = String.Empty
        For i As Integer = 0 To Dt.Columns.Count - 1
            StrDc(i) = Dt.Columns(i).Caption
            HeadStr += """" & StrDc(i) & """ : """ & StrDc(i) & i.ToString() & "¾" & ""","
        Next

        HeadStr = HeadStr.Substring(0, HeadStr.Length - 1)
        Dim Sb As New StringBuilder()

        Sb.Append("{""" & Convert.ToString("WebServiceData") & """ : [")
        For i As Integer = 0 To Dt.Rows.Count - 1
            Dim TempStr As String = HeadStr
            Sb.Append("{")
            For j As Integer = 0 To Dt.Columns.Count - 1
                TempStr = TempStr.Replace(Dt.Columns(j).ToString & j.ToString() & "¾", Dt.Rows(i)(j).ToString())
            Next
            Sb.Append(TempStr & "},")
        Next
        Sb = New StringBuilder(Sb.ToString().Substring(0, Sb.ToString().Length - 1))

        Sb.Append("]}")
        Return Sb.ToString()
    End Function

αλλα πάλι μου βάζει xml header
<string xmlns="http://www.minosnet.gr/">{"WebServiceData" : [{"CustomerID" : "31","FName" : "ÎÏÏÏÎ±Ï","LName" : "ÎÎ¿ÏÏÏÎ¿ÏÎ»Î¬ÎºÎ·Ï"},{"CustomerID" : "32","FName" : "ÎÎ¹Î¬Î½Î½Î·Ï","LName" : "ÎÎ±ÏÎ±Î¼Î¿ÏÏÎ±Î´Î¬ÎºÎ·Ï"},{"CustomerID" : "33","FName" : "ÎÎ¶Î±Î¼ÏÎÎ»Î±","LName" : "Î£ÏÎµÏÎ±Î½Î¿ÏÎ´Î¬ÎºÎ·"},{"CustomerID" : "34","FName" : "ÎÎ±ÏÎ±Î»Î¯Î±","LName" : "ÎÎµÎ»Î±ÏÎ´Î®"},{"CustomerID" : "35","FName" : "ÎÎ¹ÏÎ®Î½Î·","LName" : "ÎÎ½Î´ÏÎµÎ±Î´Î¬ÎºÎ·"},{"CustomerID" : "36","FName" : "ÎÎ±ÏÎ¯Î±","LName" : "Î¤Î¶Î¹Î»Î¹Î²Î¬ÎºÎ·"},{"CustomerID" : "37","FName" : "ÎÎ¿ÏÎ¯Î½Î±","LName" : "ÎÎ±ÏÎµÎ´Î¬ÎºÎ·"},{"CustomerID" : "38","FName" : "ÎºÎºÎºÎº","LName" : "ÎÎ±ÏÎµÎ´Î¬ÎºÎ·"},{"CustomerID" : "39","FName" : "ÎÎ±Î½ÏÎ»Î·Ï","LName" : "ÎÏÎ»ÏÎ½Î¬ÎºÎ·Ï"},{"CustomerID" : "40","FName" : "ÎÎ¹ÏÏÎ³Î¿Ï","LName" : "Î¤ÏÎ¹Î»Î¹Î²Î¬ÎºÎ·Ï"}]}</string>

πώς μπορώ να επιστρέφει η ςeb method μόνο το Json αντικείμενο; Να επιστρέφω αντικείμενο τύπου Customers?(Με αντίστοιχη κλάση Customer)

ευχαριστώ και πάλι.

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Tue, 01 Feb 2011 07:35:37 GMT

Τότε αξίζει να κοιτάξεις τα WCF Data Services. Εμφανίζουν με πολύ απλό τρόπο τα περιεχόμενα ενός μοντέλου Entity Framework ως REST είτε σε μορφή Atom Feed είτε JSON και επιτρέπουν τη δημιουργία queries (κομπλέ με selects, paging, sorting) μέσω του URL, της Javascript ή ακόμα και LINQ αν η εφαρμογή σου είναι .NET. Δες αυτό το άρθρο στο MSDN Magazine για το πως μπορεί κανείς να καλέσει ένα WCF Data Service μέσω του ASP.NET Ajax library και αυτό το άρθρο του Shawn Wildermuth για το πως να το καλέσει μέσω jQuery και να πάρει πίσω JSON. Για να πάρεις JSON το μόνο που χρειάζεται είναι να βάλεις τα σωστά HTTP Header στο request (contentType: "application/json; charset=utf-8", dataType: "json")

Όσο για το πως φτιάχνεις ένα WCF Data Service, στην απλούστερη μορφή του είναι απλά το παρακάτω:

public class NorthwindService : DataService<NorthwindEntities>
{
   public static void InitializeService(IDataServiceConfiguration config)
   {
      config.SetEntitySetAccessRule("Customers", EntitySetRights.All);
    }
}

όπου NorthwindEntities είναι το context που δημιουργεί το EF και Customers το όνομα της κλάσης (του EntitySet για την ακρίβεια) που θέλεις να βγάλεις προς τα έξω

Απ: web service that returns JSON string

DaltonGR — Tue, 01 Feb 2011 05:35:00 GMT

ευχαριστώ για την απάντηση. Θα πρέπει να αρχίσω το ψάξιμο με WCF γιατί είμαι ακόμα στην αρχή. Αυτό που θέλω γενικά να κάνω είναι να δημιουργήσω 3 services που επιστρέφουν δεδομένα απο SQL server. Μόνο για ανάγνωση θα είναι αυτά τα δεδομένα.

ευχαριστώ και πάλι.

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Tue, 01 Feb 2011 02:17:12 GMT

Ουπς, λείπει και κάτι ακόμα. Πρέπει στο config του WCF service σου να ορίσεις και ένα WebHttpBinding endpoint για να μπορεί να το καλέσει κώδικας από javascript. Για παράδειγμα, έφτιαξα ένα χαζό service σε WCF 4 το οποίο λέγεται ... Service1 και χρειάστηκε να προσθέσω το παρακάτω XML μέσα στο <system.serviceModel>

	  <services>
		  <service name="WcfJsonTest.Service1">
			  <endpoint address="" behaviorConfiguration="WcfJsonTest.TestServiceBehavior" binding="webHttpBinding" contract="WcfJsonTest.IService1">
			  </endpoint>
		  </service>
	  </services>

και το παρακάτω στο <behaviors>

		  <endpointBehaviors>
			  <behavior name="WcfJsonTest.TestServiceBehavior">
				  <webHttp helpEnabled="true"/>
			  </behavior>
		  </endpointBehaviors>

Το helpEnabled ενεργοποιεί μία help σελίδα στο Service1.svc/help η οποία εμφανίζει όλες τις μεθόδους του service μου και το URL που πρέπει να φτιάξω για να το καλέσω

Το λαμπρό αποτέλεσμα είναι παρακάτω:

[{"BoolValue":true,"StringValue":"Moo"},{"BoolValue":false,"StringValue":"Moo1"}]

Απ: web service that returns JSON string

Παναγιώτης Καναβός — Mon, 31 Jan 2011 23:45:17 GMT

Μπορείς να δημιουργήσεις WCF Service το οποίο επιστρέφει JSON. Θα πρέπει όμως να αλλάξεις τον τύπο των δεδομένων σε κάτι πέρα από DataTable, π.χ. σε List<Customer>. Μετά, απλά αλλάζεις το Request/ResponseFormat των μεθόδων σου σε JSON. Δες και αυτή την ερώτηση στο StackOverflow που απαντάει ακριβώς σε αυτό που ρωτάς.